From 115a679d28736232c32c00d842fd34532e272fb5 Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Wed, 20 Sep 2023 13:28:41 -0400 Subject: [PATCH] Move docs dependencies out of pyproject.toml I find that specifying documenteer from GitHub in technote's dev extras prevents a release to PyPI because documenteer also dependends on technote. This breaks that circularity by moving the documentation dependencies into a docs-requirements.txt file that tox installs. --- docs-requirements.txt | 5 +++++ pyproject.toml | 3 --- tox.ini | 4 ++++ 3 files changed, 9 insertions(+), 3 deletions(-) create mode 100644 docs-requirements.txt diff --git a/docs-requirements.txt b/docs-requirements.txt new file mode 100644 index 0000000..934bd96 --- /dev/null +++ b/docs-requirements.txt @@ -0,0 +1,5 @@ +# Documentation dependencies are maintained here rather than in +# the pyproject.toml dev extras to avoid circular dependencies with the +# documenteer packaging. +documenteer[guide] @ git+https://github.com/lsst-sqre/documenteer@main +autodoc_pydantic diff --git a/pyproject.toml b/pyproject.toml index bca27d2..3ceaadc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -42,9 +42,6 @@ dev = [ "lxml", "cssselect", "mf2py", - # Documentation - "documenteer[guide] @ git+https://github.com/lsst-sqre/documenteer@main", - "autodoc_pydantic", ] [project.urls] diff --git a/tox.ini b/tox.ini index e4d8e63..88b3826 100644 --- a/tox.ini +++ b/tox.ini @@ -42,6 +42,8 @@ allowlist_externals = rm cp mkdir +deps = + -r docs-requirements.txt commands = sphinx-build --keep-going -n -T -b html -d {envtmpdir}/doctrees docs docs/_build/html rm -rf docs/_build/html/demo @@ -49,6 +51,8 @@ commands = [testenv:docs-linkcheck] description = Check links in the documentation. +deps = + -r docs-requirements.txt commands = sphinx-build --keep-going -n -T -b linkcheck -d {envtmpdir}/doctrees docs docs/_build/linkcheck