adding ci build for docuemntation

Author: dkazanc

.github/workflows/httomo_backends_docs.yml

@@ -0,0 +1,60 @@
+name: HTTomo-backends docs
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+jobs:
+  build-docs-publish:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash -el {0}
+    steps:
+        - name: Checkout repository code
+          uses: actions/checkout@v4
+
+        - name: Setup Python 3.10
+          uses: actions/setup-python@v4
+          with:
+            python-version: '3.10'
+
+        - name: httomo-backends-docs
+          uses: conda-incubator/setup-miniconda@v2
+          with:
+            auto-update-conda: false
+            activate-environment: httomo-backends-docs
+            environment-file: ./docs/source/doc-conda-requirements.yml
+
+        - name: Build api docs
+          run: sphinx-apidoc -feT -t=./docs/source/_templates -o ./docs/source/api ./httomo_backends
+
+        - name: Generate yaml templates
+          run: |
+            $CONDA/bin/conda activate httomo-backends-docs
+            pip install httomolib 
+            pip install httomolibgpu --no-deps
+
+        - name: Generate yaml templates
+          run: |
+            python ./httomo_backends/scripts/yaml_templates_generator.py -i ./httomo_backends/methods_database/backends/tomopy/tomopy_modules.yaml -o ./docs/build/yaml_templates/tomopy
+            python ./httomo_backends/scripts/yaml_unsupported_tomopy_remove.py -t ./docs/build/yaml_templates/tomopy -l ./httomo_backends/methods_database/backends/tomopy/tomopy.yaml
+            python ./httomo_backends/scripts/yaml_templates_generator.py -i ./httomo_backends/methods_database/backends/httomolib/httomolib_modules.yaml -o ./docs/build/yaml_templates/httomolib
+            python ./httomo_backends/scripts/yaml_templates_generator.py -i ./httomo_backends/methods_database/backends/httomolibgpu/httomolibgpu_modules.yaml -o ./docs/build/yaml_templates/httomolibgpu
+
+        - name: Generate yml docs
+          run: python ./docs/source/yaml_doc_generator.py
+
+        - name: Build html
+          run: sphinx-build -a -E -b html ./docs/source/ ./docs/build/
+
+        - name: Publish docs
+          if: github.ref_type == 'tag' || github.ref_name == 'main'
+          run: ghp-import -n -p -f ./docs/build
+          env:
+            GITHUB_TOKEN: ${{ github.token }}

.github/workflows/httomo_backends_pypi_publish.yml

@@ -25,8 +25,8 @@ jobs:
           $CONDA/bin/conda install conda-forge::pyyaml
           $CONDA/bin/pip install setuptools wheel
           $CONDA/bin/pip install build          
-          $CONDA/bin/pip install httomolib==2.1
-          $CONDA/bin/pip install --no-deps httomolibgpu==2.1.1
+          $CONDA/bin/pip install httomolib
+          $CONDA/bin/pip install --no-deps httomolibgpu
           $CONDA/bin/conda list
       - name: Generate yaml templates
         run: |

docs/source/conf.py

@@ -92,7 +92,6 @@
 html_title = "httomo-backends documentation page"
 html_copy_source = True
 html_last_updated_fmt = ""
-html_static_path = ["_static"]
 html_use_smartypants = True
 
 html_theme_options = {

docs/sphinx-build.sh

@@ -25,13 +25,13 @@ rm -rf $DIR/build/
 # add -Q to suppress warnings
 
 # sphinx-apidoc generates source files that use sphinx.ext.autodoc to document all found modules
-sphinx-apidoc -feT -t=$DIR/source/_templates -o $DIR/source/api $DIR/../httomo
+sphinx-apidoc -feT -t=$DIR/source/_templates -o $DIR/source/api $DIR/../httomo_backends
 
 # build yaml templates here:
-python $DIR/../scripts/yaml_templates_generator.py -i $DIR/../httomo/methods_database/packages/external/tomopy/tomopy_modules.yaml -o $DIR/build/yaml_templates/tomopy
-python $DIR/../scripts/yaml_unsupported_tomopy_remove.py -t $DIR/build/yaml_templates/tomopy -l $DIR/../httomo/methods_database/packages/external/tomopy/tomopy.yaml
-python $DIR/../scripts/yaml_templates_generator.py -i $DIR/../httomo/methods_database/packages/external/httomolibgpu/httomolibgpu_modules.yaml -o $DIR/build/yaml_templates/httomolibgpu
-python $DIR/../scripts/yaml_templates_generator.py -i $DIR/../httomo/methods_database/packages/external/httomolib/httomolib_modules.yaml -o $DIR/build/yaml_templates/httomolib
+python $DIR/../httomo_backends/scripts/yaml_templates_generator.py -i $DIR/../httomo_backends/methods_database/backends/tomopy/tomopy_modules.yaml -o $DIR/build/yaml_templates/tomopy
+python $DIR/../httomo_backends/scripts/yaml_unsupported_tomopy_remove.py -t $DIR/build/yaml_templates/tomopy -l $DIR/../httomo_backends/methods_database/backends/tomopy/tomopy.yaml
+python $DIR/../httomo_backends/scripts/yaml_templates_generator.py -i $DIR/../httomo_backends/methods_database/backends/httomolibgpu/httomolibgpu_modules.yaml -o $DIR/build/yaml_templates/httomolibgpu
+python $DIR/../httomo_backends/scripts/yaml_templates_generator.py -i $DIR/../httomo_backends/methods_database/backends/httomolib/httomolib_modules.yaml -o $DIR/build/yaml_templates/httomolib
 
 # Append yaml link to rst files
 python -m source.yaml_doc_generator