[#2161] .readthedocs.yaml

.readthedocs.yaml

@@ -0,0 +1,12 @@
+build:
+  os: ubuntu-20.04
+  tools:
+    python: '3.9'
+formats: all
+python:
+   install:
+   - requirements: doc/sphinx/src/requirements.txt
+sphinx:
+   configuration: doc/sphinx/conf.py
+   fail_on_warning: true
+version: 2

doc/sphinx/Makefile.am

@@ -12,10 +12,11 @@ sphinxopts += -W
 sphinxopts += -j 2
 sphinxopts += -c "${abs_srcdir}"
 
-static_sources =
-include static/static_sources.mk
-
-EXTRA_DIST += static/static_sources.mk
+static_sources  =
+static_sources += static/kea-imageonly-100bw.png
+static_sources += static/kea-logo-100x70.png
+static_sources += static/kea-logo-200.png
+static_sources += static/kea.css
 
 # ARM
 rst_arm_sources =
@@ -178,6 +179,9 @@ $(man8s): mans
 mans: $(man_sources) api-files.txt mes-files.txt
 	$(SPHINXBUILD) -M man $(srcdir) $(sphinxbuilddir) $(sphinxopts)
 
+update-python-dependencies: ./src/requirements.in
+	pip-compile -r ./src/requirements.in
+
 clean-local:
 	rm -rf $(sphinxbuilddir)
 	rm -f $(srcdir)/mes-files.txt $(srcdir)/api-files.txt

doc/sphinx/src/requirements.in

@@ -0,0 +1,2 @@
+sphinx
+sphinx-rtd-theme

doc/sphinx/src/requirements.txt

@@ -0,0 +1,61 @@
+#
+# This file is autogenerated by pip-compile with python 3.9
+# To update, run:
+#
+#    pip-compile ./src/requirements.in
+#
+alabaster==0.7.12
+    # via sphinx
+babel==2.9.1
+    # via sphinx
+certifi==2021.10.8
+    # via requests
+charset-normalizer==2.0.7
+    # via requests
+docutils==0.17.1
+    # via
+    #   sphinx
+    #   sphinx-rtd-theme
+idna==3.3
+    # via requests
+imagesize==1.3.0
+    # via sphinx
+jinja2==3.0.2
+    # via sphinx
+markupsafe==2.0.1
+    # via jinja2
+packaging==21.2
+    # via sphinx
+pygments==2.10.0
+    # via sphinx
+pyparsing==2.4.7
+    # via packaging
+pytz==2021.3
+    # via babel
+requests==2.26.0
+    # via sphinx
+snowballstemmer==2.1.0
+    # via sphinx
+sphinx==4.2.0
+    # via
+    #   -r ./src/requirements.in
+    #   sphinx-rtd-theme
+sphinx-rtd-theme==1.0.0
+    # via -r ./src/requirements.in
+sphinxcontrib-applehelp==1.0.2
+    # via sphinx
+sphinxcontrib-devhelp==1.0.2
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.0
+    # via sphinx
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.3
+    # via sphinx
+sphinxcontrib-serializinghtml==1.1.5
+    # via sphinx
+urllib3==1.26.7
+    # via requests
+
+# The following packages are considered to be unsafe in a requirements file:
+# setuptools

doc/sphinx/static/static_sources.mk

@@ -1,4 +0,0 @@
-static_sources += static/kea-imageonly-100bw.png
-static_sources += static/kea-logo-100x70.png
-static_sources += static/kea-logo-200.png
-static_sources += static/kea.css

hammer.py

@@ -1491,7 +1491,7 @@ def prepare_system_local(features, check_times):
         if 'docs' in features:
             execute('virtualenv-3 ~/venv',
                     env=env, timeout=60, check_times=check_times)
-            execute('~/venv/bin/pip install sphinx==3.5.4 sphinx-rtd-theme==0.5.2',
+            execute('~/venv/bin/pip install sphinx sphinx-rtd-theme',
                     env=env, timeout=120, check_times=check_times)
 
         if 'cql' in features:
@@ -1672,7 +1672,7 @@ def prepare_system_local(features, check_times):
         if 'docs' in features and revision == '8':
             execute('virtualenv -p /usr/bin/python3 ~/venv',
                     env=env, timeout=60, check_times=check_times)
-            execute('~/venv/bin/pip install sphinx typing sphinx-rtd-theme',
+            execute('~/venv/bin/pip install sphinx sphinx-rtd-theme',
                     env=env, timeout=120, check_times=check_times)
 
         if 'cql' in features and revision != '8':