Skip to content

Update docutils constraint #386

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

Merged
merged 2 commits into from
Oct 3, 2025
Merged

Update docutils constraint #386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18cefe3
Update docutils constraint
xylar Oct 3, 2025
5b3d813
Build docs on PRs, only publish on push
xylar Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .github/workflows/build_workflow.yml
View file
Open in desktop
Copy link
Contributor Author

@xylar xylar Oct 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, these changes won't take effect until after we merge the PR, it looks like. That's because I renamed the job, I presume.

Copy link
Contributor Author

@xylar xylar Oct 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I take that back! It's running! Just took a sec.

Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,8 @@ jobs:
run: |
python -m unittest tests/test_*.py

# If the branch updates documentation, then the docs will need to be updated.
publish-docs:
if: github.event_name == 'push'
# Build documentation on all PRs and pushes; only publish (commit to gh-pages) on pushes.
build-docs:
needs: [pre-commit-hooks, build]
runs-on: ubuntu-latest
defaults:
Expand Down Expand Up @@ -128,6 +127,7 @@ jobs:
sphinx-multiversion source _build/html

- name: Copy Docs and Commit
if: github.event_name == 'push'
run: |
# gh-pages branch must already exist
git clone https://github.com/E3SM-Project/zstash.git --branch gh-pages --single-branch gh-pages
Expand Down Expand Up @@ -155,6 +155,7 @@ jobs:
git commit -m "Update documentation" -a || true

- name: Push Changes
if: github.event_name == 'push'
uses: ad-m/github-push-action@master
with:
branch: gh-pages
Expand Down
4 changes: 1 addition & 3 deletions conda/dev.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,4 @@ dependencies:
- sphinx >=5.2.0
- sphinx-multiversion >=0.2.4
- sphinx_rtd_theme >=1.0.0
# Need to pin docutils because 0.17 has a bug with unordered lists
# https://github.com/readthedocs/sphinx_rtd_theme/issues/1115
- docutils >=0.16,<0.17
- docutils >=0.17.1
Loading