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.

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

Coordinating docs with new logging #394

Merged
merged 1 commit into from
Aug 31, 2021

Conversation

john-science
Copy link
Member

I found two errors while trying to build the docs today:

  1. The new Sphinx 4.x version of has a bug that affects us: more than one target found for cross reference should prefer current file's method over other libraries methods sphinx-doc/sphinx#4961
  2. Because of how logging works, it will sometimes run in a realm free of our changes to logging, but sometimes will import ARMI code and very much be in our logging world.

So, the fixes to these are easy:

  1. @ntouran showed he was able to eliminate the Sphinx bug by running in v3.5. But this didn't work for me. So I have set the requirement to exactly the version that worked for me.
  2. In two places in the /docs/ folder, I manually set/reset the logging to be the Python standard library version, or ours, when we need.

So the errors are fixed and the docs build, hurray! But there are still many warnings being thrown while building the docs that will have to be addressed.

@youngmit youngmit merged commit b8566ef into terrapower:master Aug 31, 2021
@john-science john-science deleted the docs_tweaks branch September 10, 2021 21:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants