Improve doc generation

abhabongse · Jul 5, 2024 · 8b06637 · 8b06637
1 parent c20d776
commit 8b06637
Show file tree

Hide file tree

Showing 12 changed files with 148 additions and 100 deletions.
diff --git a/.idea/pyright-langserver.xml b/.idea/pyright-langserver.xml
diff --git a/.idea/ruff.xml b/.idea/ruff.xml
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -22,10 +22,6 @@ repos:
       - id: ruff
         args: [ --fix ]
       - id: ruff-format
-  - repo: https://github.com/RobertCraigie/pyright-python
-    rev: v1.1.369
-    hooks:
-      - id: pyright
   - repo: https://github.com/python-poetry/poetry
     rev: "1.8.3"
     hooks:

diff --git a/docs/api/app.md b/docs/api/app.md
@@ -1,7 +1,3 @@
 # Public Application Functions
 
-Here is the complete list of public functions.
-
-::: myhelpers.dummy.longest_common_prefix
-    options:
-      show_root_heading: true
+::: myhelpers.dummy
diff --git a/docs/api/helpers.md b/docs/api/helpers.md
@@ -1,6 +1,7 @@
 # Additional Primitive Helpers
 
-Here is a list of additional primitive helpers.
+::: myhelpers.primitives.envvar
 
-::: myhelpers.primitives.envvar.EnvVariable
-::: myhelpers.primitives.singleton.SingletonMeta
+::: myhelpers.primitives.logging
+
+::: myhelpers.primitives.singleton
diff --git a/docs/index.md b/docs/index.md
@@ -11,4 +11,4 @@ Feel free to write article or customize all you want.
 
 ## Useful Links
 
-- [API Reference](API%20Reference/index.md)
+- [API Reference](api/index.md)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -32,15 +32,26 @@ theme:
     - search.highlight
 # noinspection YAMLSchemaValidation
 plugins:
+  - autorefs
   - glightbox
   - mkdocstrings:
       enabled: true
       default_handler: python
       handlers:
         python:
+          paths:
+            - src
           options:
-            show_root_heading: true
+            docstring_style: google
             heading_level: 3
+            line_length: 80
+            separate_signature: true
+            show_root_heading: true
+            show_signature_annotations: true
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            signature_crossrefs: true
+            unwrap_annotated: true
           import:
             - https://docs.python.org/3/objects.inv
   - search

diff --git a/poetry.lock b/poetry.lock
diff --git a/src/myhelpers/primitives/__init__.py b/src/myhelpers/primitives/__init__.py
@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from myhelpers.primitives.envvar import EnvVariable
+from myhelpers.primitives.envvar import EnvVar
 from myhelpers.primitives.singleton import SingletonMeta
 
-__all__ = ['EnvVariable', 'SingletonMeta']
+__all__ = ['EnvVar', 'SingletonMeta']