feat: added mkdocstrings for generating API docs

ntamas · ntamas · commit 57d0e396a454 · 2023-08-06T21:02:02.000+02:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -24,5 +24,6 @@ jobs:
           path: .cache
           restore-keys: |
             mkdocs-material-
-      - run: pip install mkdocs-material 
+      - run: >
+          pip install mkdocs-material 'mkdocstrings[python]'
       - run: mkdocs gh-deploy --force
diff --git a/docs/notes.md b/docs/notes.md
diff --git a/docs/reference.md b/docs/reference.md
@@ -0,0 +1,3 @@
+# Reference
+
+::: igraph_ctypes.Graph
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,6 +2,11 @@ site_name: igraph ctypes interface for Python
 repo_url: https://github.com/igraph/python-igraph-ctypes
 # repo_name: igraph/python-igraph-ctypes
 
+nav:
+  - Home: index.md
+  - Notes: notes.md
+  - API reference: reference.md
+
 theme:
   name: material
 
@@ -46,3 +51,8 @@ extra:
 copyright: >
   Copyright &copy; 2003 - 2023 The igraph core team –
   <a href="#__consent">Change cookie settings</a>
+
+plugins:
+  - search
+  - mkdocstrings
+
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -19,6 +19,7 @@ stimulus = { git = "https://github.com/igraph/stimulus.git", tag = "0.14.1" }
 
 [tool.poetry.group.doc.dependencies]
 mkdocs-material = "^9.1.21"
+mkdocstrings = { version = "^0.22.0", extras = ["python"] }
 
 [tool.poetry-dynamic-versioning]
 enable = true
