Skip to content

Commit

Permalink
docs: dirhtml mode for server docs
Browse files Browse the repository at this point in the history
  • Loading branch information
raddessi committed Jan 28, 2024
1 parent e2e0d65 commit a418708
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ jobs:
pip install poetry nox nox-poetry
- name: Building documentation
run: |
nox --session docs-build --force-color
nox --session docs-build --force-color -- -b dirhtml
- name: Deploy documentation 🚀
uses: JamesIves/[email protected]
with:
Expand Down
13 changes: 11 additions & 2 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ def docs_build(session: Session) -> None:
"""
# run with `-b dirhtml` for nicer URLS when building for publishing to a server
args = session.posargs or ["-b", "html", "-W", "--keep-going", "-v"]
args = session.posargs or ["-b", "html"]
session.install(".")
session.install(
"furo",
Expand All @@ -165,7 +165,16 @@ def docs_build(session: Session) -> None:
if build_dir.exists():
shutil.rmtree(build_dir)

session.run("sphinx-multiversion", "docs", "docs/_build", "--color", *args)
session.run(
"sphinx-multiversion",
"docs",
"docs/_build",
"--color",
"-W",
"--keep-going",
"-v",
*args,
)
# TODO: use the upstream versioning method once the feature is merged in to furo
session.run(
"cp",
Expand Down

0 comments on commit a418708

Please sign in to comment.