docsbuilding

Author: emmuhamm

.gitignore

@@ -28,6 +28,7 @@ share/python-wheels/
 MANIFEST
 .vscode
 
+docs/generated
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.

mkdocs.yml

@@ -31,15 +31,15 @@ markdown_extensions:
 
 plugins:
   - search
-  - exclude:
-      glob:
-        - Developer-Wiki/*
+  # - exclude:
+  #     glob:
+  #       - Developer-Wiki/*
   # - gen-files:
       # scripts:
       #   - docs/utils/generate_ghpages_docstrings.py
-  - literate-nav:
-      nav_file: README.md
-  - section-index
+  # - literate-nav:
+  #     nav_file: README.md
+  # - section-index
   - mkdocstrings:
       default_handler: python
       handlers:

pyproject.toml

@@ -29,6 +29,12 @@ dev = [
   "pytest-cov",
 ]
 test = ["pytest", "pytest-mypy", "pytest-cov", "types-pytz"]
+docs = [
+  "mkdocs",
+  "mkdocs-material",
+  "mkdocstrings",
+  "mkdocstrings-python",
+]
 
 [project.scripts]
 daqpytools-logging-demonstrator = "daqpytools.apps.logging_demonstrator:main"