Add documentation action

.github/workflows/docs.yml

@@ -0,0 +1,35 @@
+name: Docs
+on:
+- push
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+
+    - name: Install requirements for documentation generation
+      run: |
+        python -m pip install --upgrade pip setuptools wheel
+        python -m pip install docutils pydoctor
+
+    - name: Generate API documentation with pydoctor
+      run: |
+
+        # Run pydoctor build
+        pydoctor \
+            --project-url=https://github.com/$GITHUB_REPOSITORY \
+            --html-viewsource-base=https://github.com/$GITHUB_REPOSITORY/tree/$GITHUB_SHA \
+            --config pyproject.toml
+
+    - name: Push API documentation to Github Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs
+        commit_message: "Generate API documentation"

pyproject.toml

@@ -24,3 +24,13 @@ dynamic = ["version"]
 
 [project.optional-dependencies]
 dev = ["ruff", "isort", "black"]
+
+[tool.pydoctor]
+project-name = "ModelMimic"
+make-html = true
+html-output = "./docs"
+docformat = "numpy"
+intersphinx = "https://docs.python.org/3/objects.inv"
+theme = "readthedocs"
+privacy = ["PRIVATE:**.__*__", "PUBLIC:**.__init__"]
+add-package = ["./modelmimic"]