Merge pull request #11 from GEMScienceTools/build-pages

Build GitHub Pages for Documentation

Author: mouayed-nafeh

.github/workflows/linux_test.yml

@@ -1,4 +1,4 @@
-name: Linux tests
+name: Linux tests and Page deployment
 on:
   pull_request:
   workflow_dispatch:
@@ -50,3 +50,34 @@ jobs:
           source ~/openquake/bin/activate
           cd openquake/vmtk
           pytest -v --doctest-modules -x --color=yes --durations=10 tests/
+
+
+  pages:
+    needs: vulnerability_test
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+    - name: Install sphinx and themes
+      run: |
+        python -m pip install --upgrade pip
+        pip install sphinx
+        pip install recommonmark
+        pip install sphinx_rtd_theme
+        pip install nbsphinx
+    - name: Make html pages
+      run: |
+        cd docsrc ; sphinx-apidoc -o contents/ ../openquake ; make html
+        touch _build/html/.nojekyll
+
+    - name: Deploy to GitHub Pages
+      if: success()
+      uses: crazy-max/ghaction-github-pages@v4
+      with:
+        target_branch: gh-pages
+        build_dir: docsrc/_build/html/
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -155,7 +155,7 @@ This work is licensed under an AGPL v3 license (https://www.gnu.org/licenses/agp
 
 # 📚 Documentation
 
-[WIP]
+For detailed documentation and user guidance on using the toolkit for vulnerability modeling, including installation instructions, key functionalities, and example workflows, please visit: [https://gemsciencetools.github.io/oq-vmtk](https://gemsciencetools.github.io/oq-vmtk/)
 
 # 📑 References