search

google / gf180mcu-pdk

PDK for GlobalFoundries' 180nm MCU bulk process technology (GF180MCU).
https://gf180mcu-pdk.rtfd.io
Apache License 2.0
372 stars 53 forks source link

Fixing docs warnings #35

Open mohanad0mohamed opened 2 years ago

mohanad0mohamed commented 2 years ago

Fixes #20

mohanad0mohamed commented 2 years ago

Before merging this pull request, These pull requests https://github.com/google/globalfoundries-pdk-ip-gf180mcu_fd_ip_sram/pull/5 and https://github.com/google/globalfoundries-pdk-libs-gf180mcu_fd_io/pull/2 should be merged first to solve 7 warnings found in this build https://gf180mcu-pdk--35.org.readthedocs.build/en/35/

mohanad0mohamed commented 2 years ago

This PR should be merged after all these:

mohanad0mohamed commented 2 years ago

Renamed the extension of role as in https://github.com/google/open-source-pdks/pull/18

mohanad0mohamed commented 2 years ago

Latest update: this PR should be merged after all these:

mohanad0mohamed commented 2 years ago

Added exclusion of code-of-conduct.rst and contributing.rst in conf.py

mithro commented 2 years ago

The docs build is also failing with

Running Sphinx v5.1.1
fatal: --unshallow on a complete repository does not make sense

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/gf180mcu-pdk/envs/35/lib/python3.7/site-packages/sphinx/registry.py", line 442, in load_extension
    mod = import_module(extname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/gf180mcu-pdk/envs/35/lib/python3.7/importlib/__init__.py", line 127, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
  File "<frozen importlib._bootstrap>", line 1006, in _gcd_import
  File "<frozen importlib._bootstrap>", line 983, in _find_and_load
  File "<frozen importlib._bootstrap>", line 965, in _find_and_load_unlocked
ModuleNotFoundError: No module named 'sphinx_pdk_roles'

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/gf180mcu-pdk/envs/35/lib/python3.7/site-packages/sphinx/cmd/build.py", line 276, in build_main
    args.pdb)
  File "/home/docs/checkouts/readthedocs.org/user_builds/gf180mcu-pdk/envs/35/lib/python3.7/site-packages/sphinx/application.py", line 222, in __init__
    self.setup_extension(extension)
  File "/home/docs/checkouts/readthedocs.org/user_builds/gf180mcu-pdk/envs/35/lib/python3.7/site-packages/sphinx/application.py", line 400, in setup_extension
    self.registry.load_extension(self, extname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/gf180mcu-pdk/envs/35/lib/python3.7/site-packages/sphinx/registry.py", line 446, in load_extension
    err) from err
sphinx.errors.ExtensionError: Could not import extension sphinx_pdk_roles (exception: No module named 'sphinx_pdk_roles')

Extension error:
Could not import extension sphinx_pdk_roles (exception: No module named 'sphinx_pdk_roles')
Docs dir is: /home/docs/checkouts/readthedocs.org/user_builds/gf180mcu-pdk/checkouts/35/docs