]> git.ipfire.org Git - thirdparty/psycopg.git/commitdiff
Docs building dependencies updated
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>
Mon, 12 Jul 2021 23:50:32 +0000 (01:50 +0200)
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>
Tue, 13 Jul 2021 00:21:27 +0000 (02:21 +0200)
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.

docs/Makefile
docs/requirements.txt [deleted file]
psycopg/setup.py

index 7a9bfaaa64ce3061fbce32689056a3ab0c3e7e90..e63cf1834839a6eb681480e3c3e59fc18d4a5052 100644 (file)
@@ -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 (file)
index 2f7344f..0000000
+++ /dev/null
@@ -1,4 +0,0 @@
-Sphinx >= 3.3, < 3.4
-docutils >= 0.16, < 0.17
-sphinx-autodoc-typehints >= 1.12, < 1.13
-furo
index 58a1026200a0cae1fd8a109f4adcce77d28f9c1e..656d9a1200fd212e81e636d2e961d557fe0e028a 100644 (file)
@@ -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(