Add flag to disable docstrings plugin

Author: mdellweg

src/pulp_docs/cli.py

@@ -1,14 +1,21 @@
 import click
 
 from mkdocs.__main__ import cli as mkdocs_cli
-from pulp_docs.context import ctx_blog, ctx_draft
+from pulp_docs.context import ctx_blog, ctx_docstrings, ctx_draft
 
 
 def blog_callback(ctx: click.Context, param: click.Parameter, value: bool) -> bool:
     ctx_blog.set(value)
     return value
 
 
+def docstrings_callback(
+    ctx: click.Context, param: click.Parameter, value: bool
+) -> bool:
+    ctx_docstrings.set(value)
+    return value
+
+
 def draft_callback(ctx: click.Context, param: click.Parameter, value: bool) -> bool:
     ctx_draft.set(value)
     return value
@@ -19,7 +26,14 @@ def draft_callback(ctx: click.Context, param: click.Parameter, value: bool) -> b
     default=True,
     expose_value=False,
     callback=blog_callback,
-    help="Don't fail if repositories are missing.",
+    help="Build blog.",
+)
+docstrings_option = click.option(
+    "--docstrings/--no-docstrings",
+    default=True,
+    expose_value=False,
+    callback=docstrings_callback,
+    help="Enable mkdocstrings plugin.",
 )
 
 draft_option = click.option(
@@ -31,9 +45,8 @@ def draft_callback(ctx: click.Context, param: click.Parameter, value: bool) -> b
 
 main = mkdocs_cli
 
-build_command = main.commands.get("build")
-serve_command = main.commands.get("serve")
-draft_option(build_command)
-draft_option(serve_command)
-blog_option(build_command)
-blog_option(serve_command)
+for command_name in ["build", "serve"]:
+    sub_command = main.commands.get(command_name)
+    draft_option(sub_command)
+    blog_option(sub_command)
+    docstrings_option(sub_command)

src/pulp_docs/context.py

@@ -2,4 +2,5 @@
 
 
 ctx_blog = ContextVar("ctx_blog", default=True)
+ctx_docstrings = ContextVar("ctx_docstrings", default=True)
 ctx_draft = ContextVar("ctx_draft", default=False)

src/pulp_docs/plugin.py

@@ -15,7 +15,7 @@
 from mkdocs.structure.pages import Page
 from mkdocs.utils.templates import TemplateContext
 
-from pulp_docs.context import ctx_blog, ctx_draft
+from pulp_docs.context import ctx_blog, ctx_docstrings, ctx_draft
 
 log = get_plugin_logger(__name__)
 
@@ -229,6 +229,7 @@ class PulpDocsPlugin(BasePlugin[PulpDocsPluginConfig]):
     def on_config(self, config: MkDocsConfig) -> MkDocsConfig | None:
         # Two directories up from docs is where we expect all the other repositories.
         self.blog = ctx_blog.get()
+        self.docstrings = ctx_docstrings.get()
         self.draft = ctx_draft.get()
 
         self.pulp_docs_dir = Path(config.docs_dir).parent
@@ -260,6 +261,9 @@ def on_config(self, config: MkDocsConfig) -> MkDocsConfig | None:
         blog_plugin = config.plugins["material/blog"]
         blog_plugin.config["enabled"] = self.blog
 
+        mkdocstrings_plugin = config.plugins["mkdocstrings"]
+        mkdocstrings_plugin.config["enabled"] = self.docstrings
+
         return config
 
     def on_files(self, files: Files, /, *, config: MkDocsConfig) -> Files | None: