Skip to content

Fixing docs warnings #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fixing docs warnings #35

wants to merge 1 commit into from

Conversation

@mohanad0mohamed
Copy link
Contributor

Fixes #20

  • All warnings have been fixed and tested locally.
  • It seems like there are some edits to be able to be merged with main.

@mithro mithro mentioned this pull request Jul 26, 2022
Merged
@mithro mithro self-requested a review July 26, 2022 02:28
@mohanad0mohamed
Copy link
Contributor Author

mohanad0mohamed commented Jul 26, 2022 •
edited
Loading

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

@mithro mithro requested a review from atorkmabrains August 2, 2022 17:07
atorkmabrains
atorkmabrains approved these changes Aug 2, 2022
View reviewed changes
Copy link
Collaborator

@atorkmabrains atorkmabrains left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve this change per @mithro request the files has been moved to a different location.

mithro
mithro suggested changes Aug 2, 2022
View reviewed changes
Copy link
Contributor

@mithro mithro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change will need to be rebased onto the latest changes which have been merged.

mithro
mithro suggested changes Aug 3, 2022
View reviewed changes
Copy link
Contributor

@mithro mithro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should add fail_on_warning: true flag back to the .readthedocs.yml file since I ended up removing that from #31 (comment)

docs/conf.py
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosectionlabel',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this extension disabled? I think we want to make sure that every section has a label?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because it introduces warnings on duplicate labels. I have added suppressor instead.

docs/index.rst
Welcome to GlobalFoundries 0.18UM 3.3V/(5V)6V MCU PDK's documentation!
****************************************************************************

.. include:: common.inc
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this remove is needed any more?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicate thus produce warning.

@mohanad0mohamed
Copy link
Contributor Author

This PR should be merged after all these:

@mohanad0mohamed mohanad0mohamed requested a review from mithro August 3, 2022 19:46
@mohanad0mohamed
Copy link
Contributor Author

Renamed the extension of role as in google/open-source-pdks#18

@mohanad0mohamed
Copy link
Contributor Author

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

@mohanad0mohamed
Copy link
Contributor Author

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

mithro
mithro reviewed Aug 12, 2022
View reviewed changes
Copy link
Contributor

@mithro mithro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change looks pretty good?

Bunch of things;

  • I think this needs the same changes as found in google/open-source-pdks#22
  • Can you rebase this change?
  • Why did you change the symlink to not include the docs directory?

@mithro
Copy link
Contributor

mithro commented Aug 12, 2022

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

mithro
mithro reviewed Aug 12, 2022
View reviewed changes
docs/conf.py
'Thumbs.db',
'.DS_Store',
'.vscode',
'IPs/**/code-of-conduct.rst',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you just drop the IPs bit? IE Just **/code-of-conduct.rst?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@mithro mithro mithro requested changes

@atorkmabrains atorkmabrains atorkmabrains approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Fix all the warnings produced when building sphinx documentation

3 participants

@mohanad0mohamed @mithro @atorkmabrains