From 4eca575c9117390db7ca3dfb58838f104addab37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ole=20Sch=C3=BCtt?= Date: Sun, 30 Jun 2024 21:54:37 +0200 Subject: [PATCH] Docs: Pin versions of python packages --- docs/README.md | 2 +- docs/requirements.txt | 5 +++++ tools/docker/scripts/test_manual.sh | 8 +------- 3 files changed, 7 insertions(+), 8 deletions(-) create mode 100644 docs/requirements.txt diff --git a/docs/README.md b/docs/README.md index ecf2a56e4d..5d1dcee0ad 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,7 +7,7 @@ To build a local version of the manual perform the following steps: 1. Install the required Python packaged: - `pip3 install sphinx myst-parser sphinx_rtd_theme sphinxcontrib-youtube lxml` + `pip3 install -r ./docs/requirements.txt` 1. (optional) Build a CP2K binary and use it to generate the `cp2k_input.xml` and `references.html` files: diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000000..969c746d30 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +lxml==5.2.2 +Sphinx==7.3.7 +myst-parser==3.0.1 +sphinx-rtd-theme==2.0.0 +sphinxcontrib-youtube==1.4.1 diff --git a/tools/docker/scripts/test_manual.sh b/tools/docker/scripts/test_manual.sh index 647e0ec05a..e6dfe2fea3 100755 --- a/tools/docker/scripts/test_manual.sh +++ b/tools/docker/scripts/test_manual.sh @@ -35,13 +35,7 @@ python3 -m venv /opt/venv export PATH="/opt/venv/bin:$PATH" # install python packages -# PLEASE KEEP DEPENDENCIES IN SYNC WITH /docs/README.md. -pip3 install --quiet \ - sphinx \ - myst-parser \ - sphinx_rtd_theme \ - sphinxcontrib-youtube \ - lxml +pip3 install -r /opt/cp2k/docs/requirements.txt echo -e "\n========== Generating Manual =========="