Use Sphinx dirhtml (#125)

phasorpy · Sep 23, 2024 · efa7582 · efa7582
1 parent ecabfe9
commit efa7582
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 20 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -36,19 +36,19 @@ jobs:
       - name: Build docs
         run: |
           cd docs
-          make html
+          make dirhtml
       - name: Upload artifacts
         uses: actions/upload-artifact@v4
         with:
           name: docs
-          path: docs/_build/html
+          path: docs/_build/dirhtml
       - name: Deploy docs
         if: github.event_name == 'push'
         uses: peaceiris/actions-gh-pages@v4
         with:
           personal_token: ${{ secrets.PHASORPY_DOC_DEPLOY_KEY }}
           external_repository: phasorpy/phasorpy.github.io
-          publish_dir: docs/_build/html
+          publish_dir: docs/_build/dirhtml
           publish_branch: main
           destination_dir: docs/${{github.ref_name}}
           # cname: phasorpy.org
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -47,7 +47,7 @@ jobs:
       - name: Build docs
         run: |
           cd docs
-          make html
+          make dirhtml
 
   test_win_mac:
     name: Test Windows and macOS
@@ -76,7 +76,7 @@ jobs:
       - name: Build docs
         run: |
           cd docs
-          make html
+          make dirhtml
 
   build_wheels:
     name: Test cibuildwheel

diff --git a/README.md b/README.md
@@ -3,13 +3,13 @@
 PhasorPy is an open-source Python library for the analysis of fluorescence
 lifetime and hyperspectral images using the phasor approach.
 
-- License: [MIT](https://www.phasorpy.org/docs/stable/license.html)
+- License: [MIT](https://www.phasorpy.org/docs/stable/license/)
 - Documentation: [phasorpy.org](https://www.phasorpy.org)
 - Source code: [github.com/phasorpy/phasorpy](https://github.com/phasorpy/phasorpy)
 - Bug reports and questions: [github.com/phasorpy/phasorpy/issues](https://github.com/phasorpy/phasorpy/issues)
 
 PhasorPy is a community-maintained project.
-[Contributions](https://www.phasorpy.org/docs/stable/contributing.html)
+[Contributions](https://www.phasorpy.org/docs/stable/contributing/)
 in the form of bug reports, bug fixes, feature implementations, documentation,
 datasets, and enhancement proposals are welcome.
 

diff --git a/docs/api/_private/_phasorpy.rst → docs/api/_phasorpy.rst b/docs/api/_private/_phasorpy.rst → docs/api/_phasorpy.rst
diff --git a/docs/api/_private/index.rst b/docs/api/_private/index.rst
diff --git a/docs/api/_private/_utils.rst → docs/api/_utils.rst b/docs/api/_private/_utils.rst → docs/api/_utils.rst
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -21,5 +21,6 @@ PhasorPy library version |version|.
     color
     datasets
     utils
+    _utils
+    _phasorpy
     cli
-    _private/index