Skip to content

Commit

Permalink
Update workflow to use Sphinx 7
Browse files Browse the repository at this point in the history
The builds were failing because the sphinx-action used by our workflow
defaulted to Sphinx 2.2.0 regardless of what was in the pyproject.toml
The current solution according to ammaraskar/sphinx-action#56 is to use
a tag corresponding to the sphinx version you want to use.
  • Loading branch information
chrisbrickhouse committed Mar 13, 2024
1 parent 864ed1c commit c5450b4
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Sphinx Build
uses: ammaraskar/sphinx-action@0.4
uses: ammaraskar/sphinx-action@7.0.1
with:
docs-folder: "docs/"

26 changes: 13 additions & 13 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ numpy = "^1.22"
tqdm = "^4.64.0"

[tool.poetry.dev-dependencies]
sphinx = "^5"
sphinx = "^7"
jinja2 = "~3.0"
pylint = "^2.5.2"

Expand Down

0 comments on commit c5450b4

Please sign in to comment.