docs: add API autodocumentation with mkdocstrings

Author: Guts

docs/api.md

@@ -0,0 +1,29 @@
+---
+icon: fontawesome/solid/code
+---
+
+# API
+
+## Core
+
+::: mkdocs_rss_plugin.plugin.GitRssPlugin
+
+----
+
+::: mkdocs_rss_plugin.config.RssPluginConfig
+
+----
+
+::: mkdocs_rss_plugin.constants
+
+----
+
+::: mkdocs_rss_plugin.models.PageInformation
+
+----
+
+::: mkdocs_rss_plugin.util.Util
+
+## Integrations
+
+::: mkdocs_rss_plugin.integrations.theme_material_social_plugin.IntegrationMaterialSocialCards

mkdocs.yml

@@ -57,6 +57,7 @@ nav:
     - configuration.md
     - integrations.md
   - Contributing: contributing.md
+  - API: api.md
   - Changelog: changelog.md
 
 plugins:
@@ -79,6 +80,20 @@ plugins:
       minify_html: true
       htmlmin_opts:
         remove_comments: true
+  - mkdocstrings:
+      enabled: !ENV [MKDOCS_ENABLE_PLUGIN_MKDOCSTRINGS, true]
+      default_handler: python
+      handlers:
+        python:
+          options:
+            docstring_style: google
+            heading_level: 3
+            ignore_init_summary: false
+            show_source: false
+          merge_init_into_class: true
+          paths: [.]
+          show_root_heading: true
+
   - privacy:
       enabled: !ENV [MKDOCS_ENABLE_PLUGIN_PRIVACY, true]
       cache_dir:

requirements/documentation.txt

@@ -5,4 +5,5 @@ mkdocs-git-committers-plugin-2>=1.2,<1.3
 mkdocs-git-revision-date-localized-plugin>=1,<1.3
 mkdocs-material[imaging]>=9.5.1,<10
 mkdocs-minify-plugin==0.7.*
+mkdocstrings[python]>=0.18,<1
 termynal>=0.11.1,<0.12