Docs: Pin versions of python packages

This commit is contained in:
Ole Schütt 2024-06-30 21:54:37 +02:00 committed by Ole Schütt
parent ce58a42e59
commit 4eca575c91
3 changed files with 7 additions and 8 deletions

View file

@ -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:

5
docs/requirements.txt Normal file
View file

@ -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

View file

@ -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 =========="