Change sphinx to pdocs

hezarai · Aug 17, 2023 · bd8302f · bd8302f
1 parent 79e0456
commit bd8302f
Show file tree

Hide file tree

Showing 45 changed files with 42 additions and 1,230 deletions.
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -1,24 +1,49 @@
-name: Deploy Sphinx docs
-on: [push, pull_request, workflow_dispatch]
+name: Publish docs
+
+# build the documentation whenever there are new commits on main
+on:
+  push:
+    branches:
+      - main
+    # Alternative: only build for tags.
+    # tags:
+    #   - '*'
+
+# security: restrict permissions for CI jobs.
 permissions:
-    contents: write
+  contents: read
+
 jobs:
+  # Build the documentation and upload the static HTML files as an artifact.
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/setup-python@v3
-      - name: Install dependencies
-        run: |
-          pip install sphinx sphinx_rtd_theme furo sphinx_copybutton docutils sphinx_inline_tabs sphinx_removed_in
-      - name: Sphinx build
-        run: |
-          sphinx-build -b html docs/source/ docs/build/html
-      - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
-        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+      - uses: actions/setup-python@v4
         with:
-          publish_branch: gh-pages
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/build/html
-          force_orphan: true
+          python-version: '3.9'
+
+      # ADJUST THIS: install all dependencies (including pdoc)
+      - run: pip install pdoc
+      # ADJUST THIS: build your documentation into docs/.
+      # We use a custom build script for pdoc itself, ideally you just run `pdoc -o docs/ ...` here.
+      - run: pdoc -o docs/source
+
+      - uses: actions/upload-pages-artifact@v2
+        with:
+          path: docs/source
+
+  # Deploy the artifact to GitHub pages.
+  # This is a separate job so that only actions/deploy-pages has the necessary permissions.
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v2
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/source/conf.py b/docs/source/conf.py
diff --git a/docs/source/hezar.data.datasets.rst b/docs/source/hezar.data.datasets.rst
diff --git a/docs/source/hezar.data.rst b/docs/source/hezar.data.rst
diff --git a/docs/source/hezar.embeddings.rst b/docs/source/hezar.embeddings.rst
diff --git a/docs/source/hezar.metrics.rst b/docs/source/hezar.metrics.rst
diff --git a/docs/source/hezar.models.audio_classification.rst b/docs/source/hezar.models.audio_classification.rst
diff --git a/docs/source/hezar.models.image2text.crnn.rst b/docs/source/hezar.models.image2text.crnn.rst
diff --git a/docs/source/hezar.models.image2text.rst b/docs/source/hezar.models.image2text.rst
diff --git a/docs/source/hezar.models.image2text.trocr.rst b/docs/source/hezar.models.image2text.trocr.rst