From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
Date: Mon, 12 Jul 2021 23:50:32 +0000 (+0200)
Subject: Docs building dependencies updated
X-Git-Tag: 3.0.dev1~23
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=307745a5cadfd5fb03558d80eddd283d9d0ccd62;p=thirdparty%2Fpsycopg.git

Docs building dependencies updated

With the current documentation the image in advanced/adapt is not
displayed. Trying if upgrading fixes the issue because the furo theme
was upgraded but Sphinx didn't and they may be incompatible now.

Docs build dependencies moved to setup.py.
---

diff --git a/docs/Makefile b/docs/Makefile
index 7a9bfaaa6..e63cf1834 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -22,8 +22,7 @@ env: .venv
 
 .venv: requirements.txt
 	$(PYTHON) -m venv .venv
-	./.venv/bin/pip install -e ../psycopg
-	./.venv/bin/pip install -r requirements.txt
+	./.venv/bin/pip install -e ../psycopg[docs]
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
diff --git a/docs/requirements.txt b/docs/requirements.txt
deleted file mode 100644
index 2f7344f62..000000000
--- a/docs/requirements.txt
+++ /dev/null
@@ -1,4 +0,0 @@
-Sphinx >= 3.3, < 3.4
-docutils >= 0.16, < 0.17
-sphinx-autodoc-typehints >= 1.12, < 1.13
-furo
diff --git a/psycopg/setup.py b/psycopg/setup.py
index 58a102620..656d9a120 100644
--- a/psycopg/setup.py
+++ b/psycopg/setup.py
@@ -31,6 +31,7 @@ extras_require = {
     "binary": [
         f"psycopg-binary == {version}",
     ],
+    # Requirements to run the test suite
     "test": [
         "mypy >= 0.812",
         "pproxy >= 2.7, < 2.8",
@@ -39,11 +40,19 @@ extras_require = {
         "pytest-randomly >= 3.7, < 3.8",
         "tenacity >= 7, < 7.1",
     ],
+    # Requirements needed for development
     "dev": [
         "black",
         "flake8 >= 3.8, < 3.9",
         "mypy >= 0.812",
     ],
+    # Requirements needed to build the documentation
+    "docs": [
+        "Sphinx >= 4.1, < 4.2",
+        "docutils >= 0.17, < 0.18",
+        "sphinx-autodoc-typehints >= 1.12, < 1.13",
+        "furo >= 2021.7.5b38",
+    ],
 }
 
 setup(