Changing documentation system from pdoc3 to mkdocs with mkapi

Author: nullhack

README.md

@@ -65,7 +65,7 @@ It includes automatic generation of API documentation, tests using PyTest, code
 Flake8 linting to enforce standardized Python coding, virtual environments using Poetry, workflow automation using Poe the Poet, 
 code formatting using black and a space optimized Dockerfile to kickstart your project and run tests using the power of Docker containers. 
 
-All you need to do is to install [Cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.2/usage.html)!
+You only need to install [Cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.2/usage.html)!
 
 ---
 

{{cookiecutter.project_slug}}/.gitignore

@@ -6,6 +6,10 @@ __pycache__/
 *.py[cod]
 *$py.class
 
+# Remove html generated by documentation
+
+docs/html
+
 # Remove tests and coverage reports
 docs/cov-report
 docs/pytest_report.html

{{cookiecutter.project_slug}}/docs/api/{{cookiecutter.project_slug}}/index.html

@@ -0,0 +1,16 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml
+    docs/
+        index.md

{{cookiecutter.project_slug}}/docs/docs/index.md

@@ -0,0 +1,18 @@
+site_name: MkApi
+site_url: https://github.com/nullhack
+site_description: API documentation with MkDocs.
+site_author: nullhack
+site_dir: html
+
+plugins:
+  - search
+  - mkapi
+
+theme:
+    name: readthedocs
+
+nav:
+  - index.md
+  - API: mkapi/api/python_base_package
+  - Tests: mkapi/tests/tests
+

{{cookiecutter.project_slug}}/docs/mkdocs.yaml

@@ -22,10 +22,12 @@ black = {version = "^22.3.0", allow-prereleases = true}
 xdoctest = "^1.0.0"
 Pygments = "^2.11.2"
 darglint = "^1.8.1"
-pdoc3 = "^0.10.0"
 cookiecutter = "^1.7.3"
 pylint = "^2.13.4"
 poethepoet = "^0.16.4"
+mkdocs = "^1.4.2"
+mkapi = "^1.0.14"
+mako = "^1.2.3"
 pep8-naming = "^0.12.1"
 mypy = "^0.942"
 flake8 = "^4.0.1"
@@ -140,7 +142,7 @@ run = "poetry run python -m {{cookiecutter.package_name}}.{{cookiecutter.module_
 test = "poetry run pytest"
 pre-commit = "poetry run pre-commit run --all-files"
 lint = "poetry run flake8"
-doc = "poetry run pdoc --html . --force --output-dir docs/api"
+doc = "poetry run mkdocs serve --use-directory-urls -f docs/mkdocs.yaml"
 
 [tool.poe.tasks.docker-build]
 cmd = """

{{cookiecutter.project_slug}}/poetry.lock

@@ -0,0 +1 @@
+"""Init file for test module."""