From 8d7f00c25b6f36ba9f5e6878f0149693ab04902e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20H=C3=B6ning?= Date: Mon, 7 Mar 2022 16:08:29 +0100 Subject: [PATCH] move docs requirements into our main requirements folder (#384) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * move docs requirements into our main requirements folder, handle them with pip-tools. Signed-off-by: Nicolas Höning * add changelog entry Signed-off-by: Nicolas Höning --- .readthedocs.yaml | 4 +- Makefile | 10 ++- documentation/changelog.rst | 1 + documentation/requirements.txt | 4 -- requirements/app.txt | 3 +- requirements/docs.in | 7 ++ requirements/docs.txt | 120 +++++++++++++++++++++++++++++++++ 7 files changed, 138 insertions(+), 11 deletions(-) delete mode 100644 documentation/requirements.txt create mode 100644 requirements/docs.in create mode 100644 requirements/docs.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 73d366a17..8b2b72704 100644 --- a/.readthedocs.yaml +++ b/.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: . diff --git a/Makefile b/Makefile index d924909a6..7a1436707 100644 --- a/Makefile +++ b/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 diff --git a/documentation/changelog.rst b/documentation/changelog.rst index f63301124..79cc29270 100644 --- a/documentation/changelog.rst +++ b/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 `_] * Adapt CLI command for entering some initial structure (``flexmeasures add structure``) to new datamodel [see `PR #349 `_] +* Align documentation requirements with pip-tools [see `PR #384 `_] v0.8.0 | January 24, 2022 diff --git a/documentation/requirements.txt b/documentation/requirements.txt deleted file mode 100644 index 145f64adf..000000000 --- a/documentation/requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -sphinx==4.4.0 -sphinxcontrib.httpdomain==1.8.0 -sphinx_fontawesome==0.0.6 -sphinx_copybutton==0.5.0 diff --git a/requirements/app.txt b/requirements/app.txt index 3697c8d06..180c191c7 100644 --- a/requirements/app.txt +++ b/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 diff --git a/requirements/docs.in b/requirements/docs.in new file mode 100644 index 000000000..96f695783 --- /dev/null +++ b/requirements/docs.in @@ -0,0 +1,7 @@ +-c app.txt + +sphinx +sphinx-rtd-theme +sphinxcontrib.httpdomain +sphinx_fontawesome +sphinx_copybutton diff --git a/requirements/docs.txt b/requirements/docs.txt new file mode 100644 index 000000000..17ed18975 --- /dev/null +++ b/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