Updated doc generator [using pdoc]

ajkdrag · Mar 14, 2024 · 08701cd · 08701cd
1 parent 929360b
commit 08701cd
Show file tree

Hide file tree

Showing 14 changed files with 210 additions and 515 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,10 +11,9 @@ on:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
     permissions:
-      id-token: write
+      contents: read
     strategy:
       fail-fast: false
       matrix:
@@ -43,9 +42,6 @@ jobs:
     - name: Check code style
       run: |
         make check-style
-#    - name: Check static analysis
-#      run: |
-#        make check-static-analysis
     - name: Install package
       run: |
         pip install .
@@ -58,19 +54,36 @@ jobs:
     - name: Generate docs
       run: |
         make docs 
-    - name: Generate docs
-      run: |
-        make docs
     - name: Generate package
       if: github.event_name == 'release'
       run: |
         make dist
+    - name: Upload docs
+      uses: actions/upload-pages-artifact@v3
+      with:
+        name: docs
+        path: docs
     - name: Upload distribution package
       if: github.event_name == 'release'
       uses: actions/upload-artifact@master
       with:
         name: dist
         path: dist
+
+  deploy-docs:
+    runs-on: ubuntu-latest
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4
+
   pypi-publish:
     runs-on: ubuntu-latest
     needs: build

diff --git a/.gitignore b/.gitignore
@@ -63,7 +63,7 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
+# documentation
 docs/_build/
 docs/build/
 docs/source/api/
@@ -113,3 +113,6 @@ data/
 pretrained/
 resources/
 temp/
+
+# pdoc documentation
+docs/ocrtoolkit
diff --git a/Makefile b/Makefile
@@ -108,23 +108,16 @@ check-lint:
 check-static-analysis: check-lint check-types
 
 
-# help: docs                           - generate project documentation
+# help: docs                           - generate project documentation using pdoc
 .PHONY: docs
-docs: coverage
-	@cd docs; rm -rf source/api/ocrtoolkit*.rst source/api/modules.rst build/*
-	@cd docs; make html
+docs: 
+	@pdoc --html --force -o docs ocrtoolkit
 
 
-# help: check-docs                     - quick check docs consistency
-.PHONY: check-docs
-check-docs:
-	@cd docs; make dummy
-
-
-# help: serve-docs                     - serve project html documentation
+# help: serve-docs                     - serve project html documentation using pdoc
 .PHONY: serve-docs
-serve-docs:
-	@cd docs/build; python -m http.server --bind 127.0.0.1
+serve-docs: 
+	@pdoc --http : ocrtoolkit
 
 
 # help: dist                           - create a wheel distribution package

diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,8 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+	<link rel="preload prerender" as="document" href="./ocrtoolkit/">
+</head>
+
+</html>
diff --git a/docs/source/_static/.gitignore b/docs/source/_static/.gitignore
diff --git a/docs/source/conf.py b/docs/source/conf.py