-
Notifications
You must be signed in to change notification settings - Fork 90
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
Upgrading sphinx to bipass logging problems #551
Conversation
Upgrading Sphinx version to remove logging issues
@jakehader @drewejohnson This PR is in reference to Issue #518 |
@ntouran There are some minor visual differences in the resultant docs, that I could see. Hopefully I didn't miss anything. We don't really have an SOP for when we make massive changes to the docs, to make sure everyone still likes the way they look. Hmm. I had to exactly pin the versions of these three libraries in order for the built docs to look right:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
approved with one simple comment
Description
In an effort to reduce the strain of people trying to create their own ARMI-adjacent docs, this PR upgrades the version of Sphinx we are using from
2.2.0
to4.4.0
. It also implements some important future-proofing against Python's continuous changes to the standard library methodlogging.Logger.log()
. These changes together allow us to remove a bunch of calls tologging.setLoggerClass()
, that were causing people trouble.As part of my testing, I had GitHub Actions build these docs in Python 3.7, 3.8, and 3.9. And I verified that my changes to
runLog.py
and the docs dependencies work in all versions.Checklist
If user exposed functionality was added/changed:
doc
folder.setup.py
.