docs: migrate from pdoc to mkdocs/mkdocstrings for TechDocs (catalog branch)

Makefile

@@ -67,9 +67,10 @@ check-test-coverage:
 	@pyenv exec poetry run pytest -vv --cov=$(CODE_DIR) --cov-report=term-missing
 
 generate-docs:
-	@pyenv exec poetry run python -m pdoc --force --html ${CODE_DIR} -o docs
-	@mv docs/dynamicio/* docs
-	@rm -rf docs/dynamicio
+	@pyenv exec poetry run mkdocs build --strict
+
+serve-docs:
+	@pyenv exec poetry run mkdocs serve
 
 build-locally:
 	@pyenv exec poetry build

docs/api.md

@@ -0,0 +1,51 @@
+# API Reference
+
+Auto-generated API documentation for the `dynamicio` package, rendered by
+[`mkdocstrings`](https://mkdocstrings.github.io/) directly from Python
+docstrings.
+
+## `dynamicio.core`
+
+::: dynamicio.core
+
+## `dynamicio.config`
+
+::: dynamicio.config.io_config
+
+## `dynamicio.mixins`
+
+### S3
+
+::: dynamicio.mixins.with_s3
+
+### Postgres
+
+::: dynamicio.mixins.with_postgres
+
+### Athena
+
+::: dynamicio.mixins.with_athena
+
+### Kafka
+
+::: dynamicio.mixins.with_kafka
+
+### Local filesystem
+
+::: dynamicio.mixins.with_local
+
+### Utilities
+
+::: dynamicio.mixins.utils
+
+## Validation
+
+::: dynamicio.validations
+
+## Errors
+
+::: dynamicio.errors
+
+## CLI
+
+::: dynamicio.cli