diff --git a/docs/conf.py b/docs/conf.py index 1a8b36b5..30478b95 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -318,6 +318,9 @@ def get_version(package_name: str) -> str: # Settings for linkcheck linkcheck_anchors = False +linkcheck_ignore = [ + "https://doi.org/10.1002/andp.19955070504", # 403 for onlinelibrary.wiley.com +] # Settings for myst_nb nb_execution_show_tb = True diff --git a/tox.ini b/tox.ini index 60aea507..7dc814ef 100644 --- a/tox.ini +++ b/tox.ini @@ -3,22 +3,19 @@ envlist = py, doc, sty, -passenv = PYTHONPATH skip_install = True skip_missing_interpreters = True skipsdist = True [testenv] -description = - Run all fast unit tests and doctests allowlist_externals = pytest commands = pytest src {posargs:tests/unit} +description = + Run all fast unit tests and doctests [testenv:cov] -description = - Compute the test coverage of all unit tests allowlist_externals = pytest commands = @@ -27,36 +24,27 @@ commands = --cov-report=html \ --cov-report=xml \ --cov=qrules +description = + Compute the test coverage of all unit tests [testenv:doc] -description = - Build documentation and API through Sphinx allowlist_externals = sphinx-build -passenv = - EXECUTE_NB - GITHUB_REPO - GITHUB_TOKEN - READTHEDOCS_VERSION commands = sphinx-build \ - --color \ --keep-going \ -TW \ -b html \ docs/ docs/_build/html +description = + Build documentation and API through Sphinx +passenv = * +setenv = + FORCE_COLOR = yes [testenv:doclive] -description = - Set up a server to directly preview changes to the HTML pages allowlist_externals = sphinx-autobuild -passenv = - EXECUTE_NB - GITHUB_REPO - GITHUB_TOKEN - READTHEDOCS_VERSION - TERM commands = sphinx-autobuild \ --open-browser \ @@ -77,63 +65,60 @@ commands = --watch docs \ --watch src \ docs/ docs/_build/html - -[testenv:docnb] description = - Build documentation through Sphinx WITH output of Jupyter notebooks -passenv = - GITHUB_REPO - GITHUB_TOKEN - READTHEDOCS_VERSION + Set up a server to directly preview changes to the HTML pages +passenv = * setenv = - EXECUTE_NB = "yes" + FORCE_COLOR = yes + +[testenv:docnb] allowlist_externals = sphinx-build commands = sphinx-build \ - --color \ --keep-going \ -TW \ -b html \ docs/ docs/_build/html +description = + Build documentation through Sphinx WITH output of Jupyter notebooks +passenv = * +setenv = + EXECUTE_NB = yes + FORCE_COLOR = yes [testenv:jcache] -description = - Inspect Jupyter cache allowlist_externals = jcache changedir = docs/_build commands = jcache {posargs:notebook list} +description = + Inspect Jupyter cache [testenv:linkcheck] -description = - Check external links in the documentation (requires internet connection) -passenv = - EXECUTE_NB - READTHEDOCS_VERSION allowlist_externals = sphinx-build commands = sphinx-build \ - --color \ -T \ -b linkcheck \ docs/ docs/_build/linkcheck +description = + Check external links in the documentation (requires internet connection) +passenv = * +setenv = + FORCE_COLOR = yes [testenv:nb] -description = - Run all notebooks with pytest allowlist_externals = pytest commands = pytest --nbmake {posargs:docs} +description = + Run all notebooks with pytest [testenv:pydeps] -description = - Visualize module dependencies -deps = - pydeps changedir = src commands = pydeps qrules \ @@ -141,21 +126,23 @@ commands = --exclude *._* \ --max-bacon=1 \ --noshow -passenv = HOME +deps = + pydeps +description = + Visualize module dependencies +passenv = * [testenv:sty] -description = - Perform all linting, formatting, and spelling checks -setenv = - SKIP = pyright allowlist_externals = pre-commit commands = pre-commit run {posargs} -a +description = + Perform all linting, formatting, and spelling checks +setenv = + SKIP = pyright [testenv:test] -description = - Run ALL tests, including the slow channel tests, and compute coverage allowlist_externals = pytest commands = @@ -164,3 +151,5 @@ commands = --cov-report=html \ --cov-report=xml \ --cov=qrules +description = + Run ALL tests, including the slow channel tests, and compute coverage