#1083 (#1084)

* #1083

Author: jackdewinter

.readthedocs.yaml

@@ -14,6 +14,6 @@ mkdocs:
   configuration: newdocs/mkdocs.yml
 
 # Optionally declare the Python requirements required to build your docs
-# python:
-#   install:
-#   - requirements: docs/requirements.txt
+python:
+  install:
+  - requirements: newdocs/requirements.txt

Pipfile

@@ -11,6 +11,8 @@ flake8 = "==7.0.0"
 flake8-bugbear = "==24.2.6"
 flake8-bandit = "==4.1.1"
 mkdocs = "==1.5.3"
+mkdocstrings = "0.25.1"
+mkdocstrings-python = "1.10.2"
 mypy = "==1.9.0"
 pdoc3 = "==0.10.0"
 pre-commit = "==3.5.0"

Pipfile.lock

@@ -6,6 +6,12 @@ theme: readthedocs
 # repo_url: https://github.com/jackdewinter/pymarkdown
 docs_dir: src
 site_dir: site
+plugins:
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [..]
 nav:
   - "Introduction":
     - 'index.md'
@@ -21,6 +27,7 @@ nav:
     - rules.md
   - "Devloper Guide":
     - 'api.md'
+    - "API Listing": api/pymarkdownapi.md
     - 'development.md'
   - "Usual Project Stuff":
     - 'usual.md'

newdocs/mkdocs.yml

@@ -0,0 +1,2 @@
+mkdocstrings==0.25.1
+mkdocstrings-python==1.10.2