Skip to content

Commit

Permalink
chore: fix versioning of Sphinx in GH Actions
Browse files Browse the repository at this point in the history
  • Loading branch information
Venefilyn committed Jun 19, 2024
1 parent 56afb32 commit 31b6db2
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 4 deletions.
1 change: 0 additions & 1 deletion .devcontainer/alma9/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@ pre-commit==3.7.1
pytest==8.2.2
pytest-cov==5.0.0
coverage[toml]==7.5.3
sphinx==7.3.7
2 changes: 1 addition & 1 deletion .github/workflows/main-docs-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
- uses: ammaraskar/sphinx-action@dev
with:
docs-folder: "docs/"
pre-build-command: "pip install -r docs/requirements.txt"
pre-build-command: "pip install -r docs/requirements.txt --force-reinstall"
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr-docs-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
- uses: ammaraskar/sphinx-action@dev
with:
docs-folder: "docs/"
pre-build-command: "pip install -r docs/requirements.txt"
pre-build-command: "pip install -r docs/requirements.txt --force-reinstall"

- uses: actions/upload-artifact@v4
with:
Expand Down
7 changes: 6 additions & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,16 @@ SPHINXBUILD ?= sphinx-build
SOURCEDIR = source
BUILDDIR = build

PYTHON = python3

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile
serve:
@$(PYTHON) -m http.server --directory build/html

.PHONY: help Makefile serve

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Sphinx==7.3.7
sphinx_autodoc_typehints==2.1.1

0 comments on commit 31b6db2

Please sign in to comment.