Skip to content

Commit

Permalink
MAINT: write sphinx-build flags full
Browse files Browse the repository at this point in the history
  • Loading branch information
redeboer committed Sep 18, 2024
1 parent c4300ad commit 5d88f03
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 18 deletions.
17 changes: 9 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -113,22 +113,26 @@ depends_on = ["docnb", "linkcheck", "sty"]
[tool.pixi.feature.dev.tasks.doc]
cmd = """
sphinx-build \
--builder dirhtml \
--color \
--fail-on-warning \
--keep-going \
-TW \
-b dirhtml \
--show-traceback \
docs/ docs/_build/html
"""
env = {PYTHONWARNINGS = ""}

[tool.pixi.feature.dev.tasks.doclive]
cmd = """
sphinx-autobuild \
--builder dirhtml \
--open-browser \
--re-ignore .*/.ipynb_checkpoints/.* \
--re-ignore .*/__pycache__/.* \
--re-ignore .*/.ipynb_checkpoints/.* \
--re-ignore .*\\.gitignore \
--re-ignore .*\\.tmp \
--re-ignore docs/_build/.* \
--re-ignore docs/_images/.* \
--re-ignore docs/.*\\.csv \
--re-ignore docs/.*\\.gif \
--re-ignore docs/.*\\.gv \
Expand All @@ -139,12 +143,9 @@ sphinx-autobuild \
--re-ignore docs/.*\\.svg \
--re-ignore docs/.*\\.yaml \
--re-ignore docs/.*\\.yml \
--re-ignore docs/_build/.* \
--re-ignore docs/_images/.* \
--re-ignore docs/api/.* \
--watch docs \
--watch src \
-b dirhtml \
docs/ docs/_build/html
"""
env = {PYTHONWARNINGS = ""}
Expand All @@ -156,9 +157,9 @@ env = {EXECUTE_NB = "\"yes\""}
[tool.pixi.feature.dev.tasks.linkcheck]
cmd = """
sphinx-build \
--builder linkcheck \
--color \
-T \
-b linkcheck \
--show-traceback \
docs/ docs/_build/linkcheck
"""
env = {PYTHONWARNINGS = ""}
Expand Down
22 changes: 12 additions & 10 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ allowlist_externals =
sphinx-build
commands =
sphinx-build \
--builder dirhtml \
--color \
--fail-on-warning \
--keep-going \
-TW \
-b dirhtml \
--show-traceback \
docs/ docs/_build/html
passenv = *
setenv =
Expand All @@ -29,11 +30,14 @@ allowlist_externals =
sphinx-autobuild
commands =
sphinx-autobuild \
--builder dirhtml \
--open-browser \
--re-ignore .*/.ipynb_checkpoints/.* \
--re-ignore .*/__pycache__/.* \
--re-ignore .*/.ipynb_checkpoints/.* \
--re-ignore .*\.gitignore \
--re-ignore .*\.tmp \
--re-ignore docs/_build/.* \
--re-ignore docs/_images/.* \
--re-ignore docs/.*\.csv \
--re-ignore docs/.*\.gif \
--re-ignore docs/.*\.gv \
Expand All @@ -44,12 +48,9 @@ commands =
--re-ignore docs/.*\.svg \
--re-ignore docs/.*\.yaml \
--re-ignore docs/.*\.yml \
--re-ignore docs/_build/.* \
--re-ignore docs/_images/.* \
--re-ignore docs/api/.* \
--watch docs \
--watch src \
-b dirhtml \
docs/ docs/_build/html
passenv = *
setenv =
Expand All @@ -62,10 +63,11 @@ allowlist_externals =
sphinx-build
commands =
sphinx-build \
--builder dirhtml \
--color \
--fail-on-warning \
--keep-going \
-TW \
-b dirhtml \
--show-traceback \
docs/ docs/_build/html
passenv = *
setenv =
Expand All @@ -79,9 +81,9 @@ allowlist_externals =
sphinx-build
commands =
sphinx-build \
--builder linkcheck \
--color \
-T \
-b linkcheck \
--show-traceback \
docs/ docs/_build/linkcheck
passenv = *
setenv =
Expand Down

0 comments on commit 5d88f03

Please sign in to comment.