chore(docs): initial docs generation with pdoc

causy-dev · Oct 22, 2023 · 6609236 · 6609236
1 parent 558af93
commit 6609236
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 22 deletions.
diff --git a/.github/workflows/create-docs.yml b/.github/workflows/create-docs.yml
@@ -34,8 +34,11 @@ jobs:
       run: |
         python -m pip install --upgrade pip poetry flake8
         poetry install
+    - name: Render docs
+      run: |
+        poetry run pdoc -d restructuredtext causy --output-directory docs
     - name: Publish to GitHub Pages
       uses: peaceiris/actions-gh-pages@v3
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: docs/build
+        publish_dir: docs/
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -21,6 +21,7 @@ mypy = "^1.5.1"
 pyinstrument = "^4.5.3"
 black = "^23.9.1"
 numpy = "^1.26.0"
+pdoc = "^14.1.0"
 
 
 [build-system]