refactor: rename MkClickDoc to MkCliDoc

phil65 · Nov 12, 2023 · 87085df · 87085df
1 parent fc96dc0
commit 87085df
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 11 deletions.
diff --git a/mknodes/__init__.py b/mknodes/__init__.py
@@ -18,7 +18,7 @@
 from .basenodes.mkcontainer import MkContainer
 from .basenodes.mkcode import MkCode
 from .basenodes._mkdocstrings import MkDocStrings
-from .basenodes.mkclickdoc import MkClickDoc
+from .basenodes.mkclidoc import MkCliDoc
 from .basenodes.mkicon import MkIcon
 from .basenodes.mkimage import MkImage
 from .basenodes.mkmaterialbadge import MkMaterialBadge
@@ -101,7 +101,7 @@
     "MkContainer",
     "MkNav",
     "MkDocStrings",
-    "MkClickDoc",
+    "MkCliDoc",
     "MkText",
     "MkKeys",
     # "MkGrid",

diff --git a/mknodes/basenodes/mkclickdoc/__init__.py → mknodes/basenodes/mkclidoc/__init__.py b/mknodes/basenodes/mkclickdoc/__init__.py → mknodes/basenodes/mkclidoc/__init__.py
@@ -10,7 +10,7 @@
 logger = log.get_logger(__name__)
 
 
-class MkClickDoc(mktemplate.MkTemplate):
+class MkCliDoc(mktemplate.MkTemplate):
     """Node for showing documentation for click / typer CLI apps."""
 
     ICON = "material/api"
@@ -65,12 +65,12 @@ def info(self) -> commandinfo.CommandInfo | None:
     def create_example_page(cls, page):
         import mknodes as mk
 
-        node = MkClickDoc(target="mkdocs_mknodes.cli:cli")
+        node = MkCliDoc(target="mkdocs_mknodes.cli:cli")
         page += mk.MkReprRawRendered(node)
-        node = MkClickDoc(target="mkdocs_mknodes.cli:cli", prog_name="build")
+        node = MkCliDoc(target="mkdocs_mknodes.cli:cli", prog_name="build")
         page += mk.MkReprRawRendered(node)
 
 
 if __name__ == "__main__":
-    docstrings = MkClickDoc.with_context("mkdocs_mknodes.cli:cli", show_subcommands=True)
+    docstrings = MkCliDoc.with_context("mkdocs_mknodes.cli:cli", show_subcommands=True)
     print(docstrings)
diff --git a/mknodes/basenodes/mkclickdoc/metadata.toml → mknodes/basenodes/mkclidoc/metadata.toml b/mknodes/basenodes/mkclickdoc/metadata.toml → mknodes/basenodes/mkclidoc/metadata.toml
@@ -1,17 +1,17 @@
 [metadata]
 icon = "mdi:api"
-name = "MkClickDoc"
+name = "MkCliDoc"
 
 [examples.cli]
 title = "MkDocs-MkNodes CLI"
 jinja = """
-{{ "mkdocs_mknodes.cli:cli" | MkClickDoc }}
+{{ "mkdocs_mknodes.cli:cli" | MkCliDoc }}
 """
 
 [examples.sub_command]
 title = "SubCommand"
 jinja = """
-{{ "mkdocs_mknodes.cli:cli" | MkClickDoc(prog_name="build") }}
+{{ "mkdocs_mknodes.cli:cli" | MkCliDoc(prog_name="build") }}
 """
 
 [fragments]

diff --git a/mknodes/manual/nodes_section.py b/mknodes/manual/nodes_section.py
@@ -43,7 +43,7 @@
     mk.MkClassTable,
     mk.MkModuleTable,
     mk.MkPluginFlow,
-    mk.MkClickDoc,
+    mk.MkCliDoc,
 ]
 
 ABOUT_THE_PROJECT_NODES = [

diff --git a/mknodes/navs/mkdefaultwebsite.py b/mknodes/navs/mkdefaultwebsite.py
@@ -28,7 +28,7 @@ def __init__(
         self.page_template.announcement_bar = mk.MkMetadataBadges("websites")
         if self.ctx.metadata.cli:
             page = self.add_page("CLI", hide="nav")
-            page += mk.MkClickDoc(show_subcommands=True)
+            page += mk.MkCliDoc(show_subcommands=True)
 
         nav = self.add_nav("Development")