Merge branch 'dev_bjorn' into gh-pages

pydna-group · Apr 18, 2024 · bc08a36 · bc08a36
2 parents 5ebb8f1 + 0f95223
commit bc08a36
Show file tree

Hide file tree

Showing 34 changed files with 508 additions and 725 deletions.
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -0,0 +1,49 @@
+on: [push, pull_request]
+
+name: "Documentation Status"
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-publish:
+    if: "! contains(github.event.head_commit.message, '[ci skip]')"
+
+    timeout-minutes: 10
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+
+    - name: Install Python dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install sphinx numpydoc sphinx-autobuild sphinx-rtd-theme
+
+    - name: Install this Python package
+      run: |
+        python -m pip install .[clipboard,download,express,gel]
+
+    - name: Session information
+      run: |
+        python --version
+
+    - name: Build documentation
+      run: |
+        cd docs
+        make html
+
+    - name: Deploy to GitHub pages 🚀
+      if: github.event_name != 'pull_request'
+      uses: JamesIves/[email protected]
+      with:
+        clean: false
+        branch: gh-pages
+        folder: docs/_build/html
diff --git a/.readthedocs.yml b/.readthedocs.yml
diff --git a/docs/BUILD_HTML.sh b/docs/BUILD_HTML.sh
diff --git a/docs/BUILD_RST_FILES.sh b/docs/BUILD_RST_FILES.sh
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/pics/BMC.png → docs/_static/BMC.png b/docs/pics/BMC.png → docs/_static/BMC.png
diff --git a/docs/pics/BMC_resized.png → docs/_static/BMC_resized.png b/docs/pics/BMC_resized.png → docs/_static/BMC_resized.png
diff --git a/docs/pics/BMC_resized_old.png → docs/_static/BMC_resized_old.png b/docs/pics/BMC_resized_old.png → docs/_static/BMC_resized_old.png
diff --git a/docs/pics/gel.png → docs/_static/gel.png b/docs/pics/gel.png → docs/_static/gel.png
diff --git a/docs/pics/pydna-web.png → docs/_static/pydna-web.png b/docs/pics/pydna-web.png → docs/_static/pydna-web.png
diff --git a/docs/pics/pydna.png → docs/_static/pydna.png b/docs/pics/pydna.png → docs/_static/pydna.png
diff --git a/docs/pics/pydna.resized.png → docs/_static/pydna.resized.png b/docs/pics/pydna.resized.png → docs/_static/pydna.resized.png
diff --git a/docs/pics/pydna240x240.png → docs/_static/pydna240x240.png b/docs/pics/pydna240x240.png → docs/_static/pydna240x240.png
diff --git a/docs/pics/pydna_512x512.png → docs/_static/pydna_512x512.png b/docs/pics/pydna_512x512.png → docs/_static/pydna_512x512.png
diff --git a/docs/pics/pydna_512x512_trsp.png → docs/_static/pydna_512x512_trsp.png b/docs/pics/pydna_512x512_trsp.png → docs/_static/pydna_512x512_trsp.png
diff --git a/docs/pics/pydna_transparent.png → docs/_static/pydna_transparent.png b/docs/pics/pydna_transparent.png → docs/_static/pydna_transparent.png
diff --git a/docs/pics/snake.png → docs/_static/snake.png b/docs/pics/snake.png → docs/_static/snake.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -8,10 +8,10 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "pydna"
-copyright = "2022, Björn F. Johansson"
+copyright = "2024, Björn F. Johansson"
 author = "Björn F. Johansson"
-
-import sys, os
+import os
+import sys
 
 # contents of docs/conf.py
 from importlib.metadata import version
@@ -25,6 +25,8 @@
 
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.coverage",
+    "sphinx.ext.napoleon",
     "sphinx.ext.doctest",
     "sphinx.ext.viewcode",
     "sphinx.ext.autosummary",
@@ -42,6 +44,9 @@
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+autodoc_member_order = 'bysource'
+autodoc_preserve_defaults = True
+
 numpydoc_show_class_members = False
 
 # -- Options for HTML output -------------------------------------------------