From 589b1e9d736fb1d7942b1dd6ff6c07a1139275d2 Mon Sep 17 00:00:00 2001
From: Erik K Anderson <erik@ekand.io>
Date: Mon, 14 Aug 2023 02:41:05 -0500
Subject: [PATCH] draft: generate reference documentation using mkdosctrings

---
 docs/reference.md            | 6 ++++++
 mkdocs.yml                   | 6 ++++++
 pyproject.toml               | 4 +++-
 wiremock/base/base_entity.py | 2 ++
 wiremock/client.py           | 2 ++
 5 files changed, 19 insertions(+), 1 deletion(-)
 create mode 100644 docs/reference.md

diff --git a/docs/reference.md b/docs/reference.md
new file mode 100644
index 0000000..12c3866
--- /dev/null
+++ b/docs/reference.md
@@ -0,0 +1,6 @@
+This part of the project documentation focuses on
+an **information-oriented** approach. Use it as a
+reference for the technical implementation of the
+`python-wiremock` project code.
+
+::: wiremock
diff --git a/mkdocs.yml b/mkdocs.yml
index 66a057f..bca9d01 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -4,6 +4,11 @@ theme:
   highlightjs: true
 plugins:
   - search
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            show_submodules: true
 markdown_extensions:
   - markdown_include.include:
       base_path: .
@@ -15,6 +20,7 @@ nav:
   - Installation: install.md
   - Testcontainers: testcontainers.md
   - Standalone: api-client.md
+  - Reference: reference.md
   - Contributing: CONTRIBUTING.md
   - Resources:
     - Examples: examples.md
diff --git a/pyproject.toml b/pyproject.toml
index 59e2fe0..aa66cb8 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -30,11 +30,13 @@ classifiers=[
 ]
 
 [tool.poetry.dependencies]
-python = "^3.7 | ^3.8 | ^3.9 | ^3.10 | ^3.11"  
+python = "^3.8 | ^3.9 | ^3.10 | ^3.11"
 requests = "^2.20.0"
 importlib-resources = "^5.12.0"
 docker = {version = "^6.1.0", optional = true}
 testcontainers = {version = "^3.7.1", optional = true}
+mkdocstrings-python = "^1.3.0"
+mkdocs-material = "^9.1.21"
 
 [tool.poetry.group.dev.dependencies]
 black = "^23.3.0"
diff --git a/wiremock/base/base_entity.py b/wiremock/base/base_entity.py
index ff99b1d..a85f4df 100644
--- a/wiremock/base/base_entity.py
+++ b/wiremock/base/base_entity.py
@@ -1,3 +1,5 @@
+"""This is example module docstring content for documentation development"""
+
 from collections import OrderedDict
 import json
 
diff --git a/wiremock/client.py b/wiremock/client.py
index b3a7510..949e1c5 100644
--- a/wiremock/client.py
+++ b/wiremock/client.py
@@ -1,3 +1,5 @@
+"""This is test docstring content for documentation development"""
+
 # import Exceptions
 from .exceptions import *