Merge pull request #2 from KlugerLab/doc_workflow

Create documentation.yml

.github/workflows/documentation.yml

@@ -0,0 +1,44 @@
+# Adapted from https://coderefinery.github.io/documentation/gh_workflow/
+name: documentation
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: |
+          pip install -r docs/requirements.txt
+      - name: Sphinx build
+        run: |
+          sphinx-build docs/source _build
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: '_build'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/publish_release.yml

@@ -10,6 +10,7 @@ on:
   push:
     tags:
       - '*'
+  workflow_dispatch:
 
 jobs:
   build:

docs/requirements.txt

@@ -1,3 +1,5 @@
+matplotlib>=3.6
+numpy>=1.25
 sphinx==8.0.2
 intersphinx-registry
 myst-parser

docs/source/conf.py

@@ -2,6 +2,7 @@
 import os
 import sys
 sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath('../..'))
 
 # Configuration file for the Sphinx documentation builder.
 #
@@ -28,12 +29,7 @@
     'sphinx.ext.coverage',
     'sphinx.ext.doctest',
     'sphinx.ext.autosummary',
-    # 'sphinx.ext.graphviz',
-    # 'sphinx.ext.ifconfig',
     'matplotlib.sphinxext.plot_directive',
-    # 'IPython.sphinxext.ipython_console_highlighting',
-    # 'IPython.sphinxext.ipython_directive',
-    # 'sphinx.ext.imgmath',
 ]
 
 templates_path = ['_templates']