-
Notifications
You must be signed in to change notification settings - Fork 317
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
Update docs infrastructure #2809
Draft
samsrabin
wants to merge
41
commits into
ESCOMP:b4b-dev
Choose a base branch
from
samsrabin:update-docs-builder-2
base: b4b-dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 1 commit
Commits
Show all changes
41 commits
Select commit
Hold shift + click to select a range
bca4618
Point doc-builder to my fork. Avoid old fork of sphinx_rtd_theme.
samsrabin 4c2361d
Resolve some sphinx warnings.
samsrabin 490d229
Fix MOSART conceptual figure references.
samsrabin 4a9e1a2
Replace a reference to RTM with MOSART.
samsrabin 497e991
Resolve "WARNING: unsupported theme option 'versions' given"
samsrabin 3511baa
Add sphinx_mdinclude.
samsrabin dcb2f0f
Add ctsm-docs.yml.
samsrabin 94874d2
Replace ctsm-docs.yml with equivalent requirements.txt.
samsrabin 5f54b61
Copy CIME's docs.yml workflow to our repo.
samsrabin 18598eb
Update docs.yml with our URL.
samsrabin e95c291
Pare down doc/requirements.txt.
samsrabin c3788bb
Have PR preview actions run even on branches from forks
samsrabin 674ab46
Add pages:write perms to build-and-deploy action.
samsrabin a5063f6
Update peaceiris/actions-gh-pages from v3 to v4.
samsrabin a5f4573
Set gibberish publish_branch.
samsrabin 442f13d
Set external_repository to hopefully publish to user's fork.
samsrabin 76c3238
Remove pages preview/push stuff; only check docs build.
samsrabin 03857ff
Remove write perms for test-build action.
samsrabin dccbcdd
Delete cleanup job.
samsrabin 868e0d0
If PR branch is from ESCOMP/CTSM (not fork), run build-and-deploy.
samsrabin 1fa1eb5
Only do test-build if the PR branch is from a fork, not ESCOMP/CTSM.
samsrabin 9d5a455
build_docs will now fail if sphinx warnings are generated.
samsrabin ee94753
TEST: Introduce Sphinx errors. Github workflow should fail.
samsrabin a893eb5
docs.yml now fails when sphinx has warnings.
samsrabin dc8dd92
Revert "Only do test-build if the PR branch is from a fork, not ESCOM…
samsrabin adb99fc
Add docs.yml job to test doc-builder.
samsrabin da0a8bd
Fix SPHINXOPTS in test-build-makefile.
samsrabin 3575ea4
Fix working dir of test-doc-builder.
samsrabin 6fb71bc
Revert "TEST: Introduce Sphinx errors. Github workflow should fail."
samsrabin 8bbdf94
TEST: Introduce Sphinx errors. Github workflow should fail.
samsrabin eb74874
Revert "TEST: Introduce Sphinx errors. Github workflow should fail."
samsrabin 6a3049e
Disable "Push new docs."
samsrabin 259ad13
Disable "needs: cleanup" for build-and-deploy.
samsrabin afd87b6
Publish preview to gh-pages-preview instead of gh-pages.
samsrabin 71c4386
Delete docs cleanup and build-and-deploy jobs.
samsrabin 76e2c6e
Docs workflow should run on PRs going to b4b-dev too.
samsrabin 2d60500
Remove action version specifiers from docs workflow.
samsrabin b7c888e
Remove branches specifiers from docs workflow.
samsrabin 0752bec
Revert "Remove action version specifiers from docs workflow."
samsrabin 5fed746
Revert doc-builder to canonical v1.0.8.
samsrabin 76c5e58
Update doc-builder to v1.1.0.
samsrabin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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.
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.
@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?