Skip to content
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

Warnings during docs build #167

Closed
bwohlberg opened this issue Jan 11, 2022 · 3 comments · Fixed by #174
Closed

Warnings during docs build #167

bwohlberg opened this issue Jan 11, 2022 · 3 comments · Fixed by #174
Assignees
@bwohlberg
Labels
documentation Improvements or additions to documentation priority: low Low priority

Comments

@bwohlberg
Copy link
Collaborator

There are currently some rather opaque warnings during docs building

WARNING: Cannot resolve forward reference in type annotations of "scico.flax.ConvBNBlock": name 'Module' is not defined
WARNING: Cannot resolve forward reference in type annotations of "scico.flax.DnCNNNet": name 'Module' is not defined
WARNING: Cannot resolve forward reference in type annotations of "scico.flax.ConvBNBlock": name 'Module' is not defined
WARNING: Cannot resolve forward reference in type annotations of "scico.flax.DnCNNNet": name 'Module' is not defined
scico/scico/flax.py:docstring of flax.linen.module.Module.bind:43: WARNING: Unexpected indentation.
scico/scico/flax.py:docstring of flax.linen.module.Module.bind:43: WARNING: Unexpected indentation.

These are clearly related to the scico.flax module, but it's not clear whether the problems due to some issue in that module itself, or in the imported flax modules.
@bwohlberg bwohlberg added documentation Improvements or additions to documentation priority: low Low priority labels Jan 11, 2022
@bwohlberg bwohlberg added priority: high High priority and removed priority: low Low priority labels Jan 11, 2022
@bwohlberg
Copy link
Collaborator Author

Switching priority to high because this seems to be killing our readthedocs builds.

@bwohlberg
Copy link
Collaborator Author

The Unexpected indentation warning seems to have been fixed in this commit
google/flax@ab38a00, but the fix doesn't seem to have made it into a release yet.

@bwohlberg bwohlberg added priority: low Low priority and removed priority: high High priority labels Jan 11, 2022
@bwohlberg
Copy link
Collaborator Author

bwohlberg commented Jan 11, 2022 •
edited
Loading

Switched back to low priority: current readthedocs build failure seems to be related to changes between 1.12 and 1.15 of sphinx-autodoc-typehints.

This was referenced Jan 11, 2022
Closed
Merged
@bwohlberg bwohlberg linked a pull request Jan 12, 2022 that will close this issue
Silence docs build warnings #174
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bwohlberg bwohlberg

Labels
documentation Improvements or additions to documentation priority: low Low priority
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Silence docs build warnings lanl/scico
2 participants
@bwohlberg @crstngc