Skip to content

Commit

Permalink
Make CI docs builds as strict as local ones (#87)
Browse files Browse the repository at this point in the history
Second attempt, this time with the warning that the stricter checks picked up resolved.
  • Loading branch information
ncoghlan authored Nov 15, 2024
1 parent 2612e25 commit 3bd619f
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs-preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ jobs:
if: github.event.action != 'closed'
with:
docs-folder: "docs/"
pre-build-command: "sphinx-build -b linkcheck . _build"
build-command: "sphinx-build -b dirhtml . _build"
pre-build-command: "sphinx-build -W -b linkcheck . _build"
build-command: "sphinx-build -W -b dirhtml . _build"

- name: Deploy preview
uses: rossjrw/pr-preview-action@v1
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ jobs:
uses: ammaraskar/[email protected]
with:
docs-folder: "docs/"
pre-build-command: "sphinx-build -b linkcheck . _build"
build-command: "sphinx-build -b dirhtml . _build"
pre-build-command: "sphinx-build -W -b linkcheck . _build"
build-command: "sphinx-build -W -b dirhtml . _build"

- name: Deploy main docs
uses: JamesIves/github-pages-deploy-action@v4
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "furo"
html_static_path = ["_static"]
html_static_path: list[str] = []
pygments_style = "sphinx"
pygments_dark_style = "monokai"

Expand Down

0 comments on commit 3bd619f

Please sign in to comment.