Add requirements.txt for required python packages

Add a file with packages for pip to install to make it easier to develop documentation and potentially use specific package versions.
laudrup · Oct 25, 2024 · c20978d · c20978d
1 parent 7e4ff74
commit c20978d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -20,8 +20,7 @@ jobs:
         DEBIAN_FRONTEND: noninteractive
       run: sudo apt-get -yq install doxygen libboost-dev libssl-dev python3-pip
     - name: Install PIP packages
-      # TODO: Consider using requirements.txt to ensure specific versions are used
-      run: sudo pip3 install sphinx breathe sphinx_bootstrap_theme sphinx_jinja sphinxcontrib_jquery
+      run: sudo pip3 install -r doc/requirements.txt
     - name: Configure build system
       run: mkdir build && cmake -Bbuild -H.
     - name: Build documentation

diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -0,0 +1,5 @@
+sphinx
+breathe
+sphinx_bootstrap_theme
+sphinx_jinja
+sphinxcontrib_jquery