Merge pull request #15 from lsst-sqre/tickets/DM-40815

DM-40815: Move docs dependencies out of pyproject.toml
lsst-sqre · Sep 20, 2023 · 6c8d43c · 6c8d43c
2 parents a5872fe + 115a679
commit 6c8d43c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/docs-requirements.txt 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
@@ -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
@@ -42,13 +42,17 @@ 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
     cp -r demo/_build/html docs/_build/html/demo
 
 [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