move docs requirements into our main requirements folder (#384)

* move docs requirements into our main requirements folder, handle them with pip-tools.

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

* add changelog entry

Signed-off-by: Nicolas Höning <nicolas@seita.nl>

.readthedocs.yaml

@@ -13,9 +13,9 @@ formats:
 
 # Set the version of Python and requirements required to build your docs
 python:
-  version: 3.8
+  version: 3.9
   install:
   - requirements: requirements/app.txt
-  - requirements: documentation/requirements.txt
+  - requirements: requirements/docs.txt
   - method: pip
     path: .

Makefile

@@ -15,7 +15,9 @@ test:
 # ---- Documentation ---
 
 update-docs:
-	make install-sphinx-tools
+	@echo "Creating docs environment ..."
+	make install-docs-dependencies
+	@echo "Creating documentation ..."
 	cd documentation; make clean; make html; cd ..
 
 update-docs-pdf:
@@ -49,20 +51,22 @@ install-flexmeasures:
 install-pip-tools:
 	pip3 install -q "pip-tools>=6.4"
 
-install-sphinx-tools:
-	pip3 install "sphinx>=4.0.3" sphinxcontrib.httpdomain sphinx-rtd-theme sphinx_fontawesome
+install-docs-dependencies:
+	pip install -r requirements/docs.txt
 
 freeze-deps:
 	make install-pip-tools
 	pip-compile -o requirements/app.txt requirements/app.in
 	pip-compile -o requirements/test.txt requirements/test.in
 	pip-compile -o requirements/dev.txt requirements/dev.in
+	pip-compile -o requirements/docs.txt requirements/docs.in
 
 upgrade-deps:
 	make install-pip-tools
 	pip-compile --upgrade -o requirements/app.txt requirements/app.in
 	pip-compile --upgrade -o requirements/test.txt requirements/test.in
 	pip-compile --upgrade -o requirements/dev.txt requirements/dev.in
+	pip-compile --upgrade -o requirements/docs.txt requirements/docs.in
 	make test
 
 

documentation/changelog.rst

@@ -29,6 +29,7 @@ Infrastructure / Support
 * Plugins can import common FlexMeasures classes (like ``Asset`` and ``Sensor``) from a central place, using ``from flexmeasures import Asset, Sensor`` [see `PR #354 <http://www.github.com/FlexMeasures/flexmeasures/pull/354>`_]
 
 * Adapt CLI command for entering some initial structure (``flexmeasures add structure``) to new datamodel [see `PR #349 <http://www.github.com/FlexMeasures/flexmeasures/pull/349>`_]
+* Align documentation requirements with pip-tools [see `PR #384 <http://www.github.com/FlexMeasures/flexmeasures/pull/384>`_]
 
 
 v0.8.0 | January 24, 2022

requirements/app.txt

@@ -24,8 +24,7 @@ attrs==21.4.0
 babel==2.9.1
     # via py-moneyed
 backports.zoneinfo==0.2.1
-    # via
-    #   workalendar
+    # via workalendar
 bcrypt==3.2.0
     # via -r requirements/app.in
 blinker==1.4

requirements/docs.in

@@ -0,0 +1,7 @@
+-c app.txt
+
+sphinx
+sphinx-rtd-theme 
+sphinxcontrib.httpdomain
+sphinx_fontawesome
+sphinx_copybutton

requirements/docs.txt

@@ -0,0 +1,120 @@
+#
+# This file is autogenerated by pip-compile with python 3.8
+# To update, run:
+#
+#    pip-compile --output-file=requirements/docs.txt requirements/docs.in
+#
+alabaster==0.7.12
+    # via sphinx
+babel==2.9.1
+    # via
+    #   -c requirements/app.txt
+    #   sphinx
+certifi==2021.10.8
+    # via
+    #   -c requirements/app.txt
+    #   requests
+    #   urllib3
+cffi==1.15.0
+    # via
+    #   -c requirements/app.txt
+    #   cryptography
+charset-normalizer==2.0.12
+    # via
+    #   -c requirements/app.txt
+    #   requests
+cryptography==36.0.1
+    # via
+    #   -c requirements/app.txt
+    #   pyopenssl
+    #   urllib3
+docutils==0.17.1
+    # via
+    #   sphinx
+    #   sphinx-rtd-theme
+idna==3.3
+    # via
+    #   -c requirements/app.txt
+    #   requests
+    #   urllib3
+imagesize==1.3.0
+    # via sphinx
+importlib-metadata==4.11.0
+    # via
+    #   -c requirements/app.txt
+    #   sphinx
+jinja2==3.0.3
+    # via
+    #   -c requirements/app.txt
+    #   sphinx
+markupsafe==2.0.1
+    # via
+    #   -c requirements/app.txt
+    #   jinja2
+packaging==21.3
+    # via
+    #   -c requirements/app.txt
+    #   sphinx
+pycparser==2.21
+    # via
+    #   -c requirements/app.txt
+    #   cffi
+pygments==2.11.2
+    # via sphinx
+pyopenssl==22.0.0
+    # via
+    #   -c requirements/app.txt
+    #   urllib3
+pyparsing==3.0.7
+    # via
+    #   -c requirements/app.txt
+    #   packaging
+pytz==2021.3
+    # via
+    #   -c requirements/app.txt
+    #   babel
+requests==2.27.1
+    # via
+    #   -c requirements/app.txt
+    #   sphinx
+six==1.16.0
+    # via
+    #   -c requirements/app.txt
+    #   sphinxcontrib.httpdomain
+snowballstemmer==2.2.0
+    # via sphinx
+sphinx==4.4.0
+    # via
+    #   -r requirements/docs.in
+    #   sphinx-copybutton
+    #   sphinx-fontawesome
+    #   sphinx-rtd-theme
+    #   sphinxcontrib.httpdomain
+sphinx-copybutton==0.5.0
+    # via -r requirements/docs.in
+sphinx-fontawesome==0.0.6
+    # via -r requirements/docs.in
+sphinx-rtd-theme==1.0.0
+    # via -r requirements/docs.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
+sphinxcontrib.httpdomain==1.8.0
+    # via -r requirements/docs.in
+urllib3[secure]==1.26.8
+    # via
+    #   -c requirements/app.txt
+    #   requests
+zipp==3.7.0
+    # via
+    #   -c requirements/app.txt
+    #   importlib-metadata