Update docs infrastructure #2809
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Based on ESMCI/cime#4613. Builds OK, but I'm not sure if the new versions setup works.
Might break things?
samsrabin
added
documentation
samsrabin
commented
Oct 3, 2024
| ### Sam Rabin 2024-10-02: Commented out to resolve "WARNING: unsupported theme option 'versions' given". Might break things! | ||
| ### html_theme_options = {} | ||
| ### html_theme_options['versions'] = {version: ''} | ||
| ### html_theme_options['versions']['[placeholder]'] = '' |
There was a problem hiding this comment.
@jasonb5 In trying to move us off that old sphinx_rtd_theme fork, I made changes based on your PR at ESMCI/cime#4613. However, I was getting "WARNING: unsupported theme option 'versions' given" warnings until I commented out this bit. I see that CIME has it uncommented, though. Does that warning still happen for CIME, or is there something better I can do to resolve it?
wwieder
removed
the
next
samsrabin
force-pushed
the
update-docs-builder-2
branch
from
f344a1e to
ff003dd
Compare
samsrabin
force-pushed
the
update-docs-builder-2
branch
from
ff003dd to
c3788bb
Compare
samsrabin
added
the
enhancement
Via updating doc-builder external to c51795f; branch update-20241002: Merge branch 'warnings-as-errors' into update-20241002
|
Closed
samsrabin
added
the
PR status: awaiting review
samsrabin
removed
the
PR status: awaiting review
|
Will ask at CSEG meeting today if I can get a new |
Treat Sphinx warnings as errors by default.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes
sphinx_rtd_themedocs/docs/:doc-builder(would require more testing; probably a different PR)Specific notes
Note that this PR tests the workflow jobs that are run on PRs of branches from forks. Specifically, the doc building is tested, but nothing is previewed or published. That only happens for PRs of branches from this canonical ESCOMP/CTSM repo; see #2812 for testing of that.
Contributors other than yourself, if any: None
CTSM Issues Fixed (include github issue #):
Are answers expected to change (and if so in what way)? The way users switch between documentation versions will be different.
Any User Interface Changes (namelist or namelist defaults changes)? No
Testing performed, if any: Builds locally with no errors or warnings. Hopefully the version switching isn't broken—it looks broken locally, but I don't know if that's just an issue of it being local.