Generate developer docs for Python API

docs/docs/developer/api.md

@@ -0,0 +1,13 @@
+# API
+
+<!-- dprint-ignore-start -->
+
+::: kpops.api
+
+<!-- dprint-ignore-end -->
+
+<!-- dprint-ignore-start -->
+
+::: kpops.pipeline.Pipeline
+
+<!-- dprint-ignore-end -->

docs/mkdocs.yml

@@ -37,6 +37,23 @@ plugins:
       exclude:
         - resources/*
   - glightbox
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [..]
+          options:
+            docstring_style: sphinx
+            show_if_no_docstring: true
+            line_length: 60
+            separate_signature: true
+            show_signature_annotations: true
+            docstring_section_style: spacy
+            show_root_heading: true
+            # The options below are not yet publicly available,
+            # but would be a nice addition when released.
+            #show_inheritance_diagram: true
+            #modernize_annotations: true
+            #parameter_headings: true
 
 extra:
   version:
@@ -120,6 +137,7 @@ nav:
               - GitHub Actions: user/references/ci-integration/github-actions.md
   - Developer Guide:
       - Getting Started: developer/getting-started.md
+      - API: developer/api.md
       - Contributing: developer/contributing.md
       - Code base:
           - Auto generation: developer/auto-generation.md

pyproject.toml

@@ -62,6 +62,7 @@ mkdocs-material = "^9.0.0"
 mkdocs-glightbox = "^0.3.1"
 mkdocs-exclude-search = "^0.6.5"
 mike = "^1.1.2"
+mkdocstrings = { extras = ["python"], version = "^0.25.1" }
 
 [tool.poetry_bumpversion.file."kpops/__init__.py"]