Added support to build docs unattended

diff --git a/.gitignore b/.gitignore
index 1abeb25fe6421fb548211f4a22927e15d16dcc31..23ad50cdc737b600bdab78f995578ffdb3b4f245 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -7,3 +7,4 @@
 /.mypy_cache
 __pycache__/
 /docs/_build/
+/docs/env/

diff --git a/docs/Makefile b/docs/Makefile
index d4bb2cbb9eddb1bb1b4f366623044af8e4830919..ff619b429fedbe14cb72977ab3a3a94cf01fe846 100644 (file)
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -7,14 +7,20 @@ SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
+PYTHON        ?= python3
 
 # Put it first so that "make" without argument is like "make help".
 help:
-       @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+       @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) || true
 
-.PHONY: help Makefile
+.PHONY: help env Makefile
+
+env: requirements.txt
+       virtualenv -p $(PYTHON) env
+       ./env/bin/pip install -e ../psycopg3
+       ./env/bin/pip install -r requirements.txt
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-       @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+       @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) || true

diff --git a/docs/_static/.keep b/docs/_static/.keep
new file mode 100644 (file)
index 0000000..e69de29

diff --git a/docs/_templates/.keep b/docs/_templates/.keep
new file mode 100644 (file)
index 0000000..e69de29

diff --git a/docs/conf.py b/docs/conf.py
index b3190381d2925c295934b1b8c5d64687c77de0c0..48b8994dfe552291a590fcb886598b5b9a630cbb 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -47,7 +47,7 @@ templates_path = ["_templates"]
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "env"]
 
 
 # -- Options for HTML output -------------------------------------------------