Merge pull request #1835 from AllenInstitute/feature/1835-update-documentation-toolchain

Author: t-b

.github/workflows/build-pr.yml

@@ -118,7 +118,7 @@ jobs:
       - name: Initial repo config
         run: tools/initial-repo-config.sh
       - name: Build documentation
-        run: tools/docker/build-documentation.sh
+        run: tools/documentation/run.sh
       - name: upload artifacts
         uses: actions/upload-artifact@v3
         if: ${{ always() }}

Packages/doc/developers.rst

@@ -16,7 +16,7 @@ Building the documentation
 
 - The script ``tools/build-documentation.sh`` allows to build the documentation locally
 - This command also installs the required pip packages, so using a dedicated virtual environment is advised
-- Linux users might directly execute the docker version in ``tools/docker/build-documentation.sh``
+- Linux users might directly execute the docker version in ``tools/documentation/run.sh``
 
 Updating documentation
 ~~~~~~~~~~~~~~~~~~~~~~

tools/build-documentation.sh

@@ -10,7 +10,7 @@ case $(uname) in
     *)
       # install the correct packages
       # this is more convenient for users
-      pip install -r $top_level/tools/docker/requirements.txt > /dev/null || exit 1
+      pip install -r $top_level/tools/documentation/requirements.txt > /dev/null || exit 1
       ;;
 esac
 

tools/docker/Dockerfile renamed to tools/documentation/Dockerfile

@@ -1,5 +1,5 @@
 breathe==4.35.0
-sphinx==6.1.3
+sphinx==7.1.2
 sphinxcontrib-fulltoc==1.2
 sphinxcontrib-images==0.9.4
 sphinxcontrib-youtube==1.2.0

tools/docker/requirements.in renamed to tools/documentation/requirements.in

@@ -198,9 +198,9 @@ snowballstemmer==2.2.0 \
     --hash=sha256:09b16deb8547d3412ad7b590689584cd0fe25ec8db3be37788be3810cbf19cb1 \
     --hash=sha256:c8e1716e83cc398ae16824e5572ae04e0d9fc2c6b985fb0f900f5f0c96ecba1a
     # via sphinx
-sphinx==6.1.3 \
-    --hash=sha256:0dac3b698538ffef41716cf97ba26c1c7788dba73ce6f150c1ff5b4720786dd2 \
-    --hash=sha256:807d1cb3d6be87eb78a381c3e70ebd8d346b9a25f3753e9947e866b2786865fc
+sphinx==7.1.2 \
+    --hash=sha256:780f4d32f1d7d1126576e0e5ecc19dc32ab76cd24e950228dcf7b1f6d3d9e22f \
+    --hash=sha256:d170a81825b2fcacb6dfd5a0d7f578a053e45d3f2b153fecc948c37344eb4cbe
     # via
     #   -r requirements.in
     #   breathe

tools/docker/requirements.txt renamed to tools/documentation/requirements.txt

@@ -16,7 +16,7 @@ top_level=$(git rev-parse --show-toplevel)
 
 # build containter
 echo "Start building Docker container 'mies-documentation'"
-docker build --build-arg USERID=$(id -u) --build-arg GROUPID=$(id -g) -t mies-documentation $top_level/tools/docker
+docker build --build-arg USERID=$(id -u) --build-arg GROUPID=$(id -g) -t mies-documentation $top_level/tools/documentation
 
 # execute build script
 # use 'docker run -it ..' for interactive debugging