draft: generate reference documentation using mkdosctrings

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

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

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"

wiremock/base/base_entity.py

@@ -1,3 +1,5 @@
+"""This is example module docstring content for documentation development"""
+
 from collections import OrderedDict
 import json
 

wiremock/client.py

@@ -1,3 +1,5 @@
+"""This is test docstring content for documentation development"""
+
 # import Exceptions
 from .exceptions import *