Doc fixes

- Fixed issue where all argparse output was missing from commmand docs since v0.10.0
Kintyre · Sep 29, 2023 · bc64a0a · bc64a0a
1 parent f8371d7
commit bc64a0a
Show file tree

Hide file tree

Showing 19 changed files with 22 additions and 19 deletions.
diff --git a/docs/source/cmd_check.rst b/docs/source/cmd_check.rst
@@ -5,7 +5,7 @@ ksconf check
 
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: check
     :nodefault:

diff --git a/docs/source/cmd_combine.rst b/docs/source/cmd_combine.rst
@@ -10,7 +10,7 @@ ksconf combine
 ==============
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: combine
     :nodefault:

diff --git a/docs/source/cmd_diff.rst b/docs/source/cmd_diff.rst
@@ -6,7 +6,7 @@ ksconf diff
 
 
 .. argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: diff
     :nodefault:

diff --git a/docs/source/cmd_filter.rst b/docs/source/cmd_filter.rst
@@ -4,7 +4,7 @@ ksconf filter
 =============
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: filter
     :nodefault:

diff --git a/docs/source/cmd_main.rst b/docs/source/cmd_main.rst
@@ -4,7 +4,7 @@ ksconf
 ======
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :prog: ksconf
     :nodefault:

diff --git a/docs/source/cmd_merge.rst b/docs/source/cmd_merge.rst
@@ -4,7 +4,7 @@ ksconf merge
 ============
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: merge
     :nodefault:

diff --git a/docs/source/cmd_minimize.rst b/docs/source/cmd_minimize.rst
@@ -7,7 +7,7 @@ ksconf minimize
 
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: minimize
     :nodefault:

diff --git a/docs/source/cmd_package.rst b/docs/source/cmd_package.rst
@@ -6,7 +6,7 @@ ksconf package
 
 
 .. argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: package
     :nodefault:

diff --git a/docs/source/cmd_promote.rst b/docs/source/cmd_promote.rst
@@ -5,7 +5,7 @@ ksconf promote
 
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: promote
     :nodefault:

diff --git a/docs/source/cmd_rest-export.rst b/docs/source/cmd_rest-export.rst
@@ -14,7 +14,7 @@ ksconf rest-export
     But for **ALL** other use cases, the ``rest-publish`` command is superior.
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: rest-export
     :nodefault:

diff --git a/docs/source/cmd_rest-publish.rst b/docs/source/cmd_rest-publish.rst
@@ -13,7 +13,7 @@ ksconf rest-publish
 
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: rest-publish
     :nodefault:

diff --git a/docs/source/cmd_snapshot.rst b/docs/source/cmd_snapshot.rst
@@ -4,7 +4,7 @@ ksconf snapshot
 ===============
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: snapshot
     :nodefault:

diff --git a/docs/source/cmd_sort.rst b/docs/source/cmd_sort.rst
@@ -4,7 +4,7 @@ ksconf sort
 ===========
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: sort
     :nodefault:

diff --git a/docs/source/cmd_unarchive.rst b/docs/source/cmd_unarchive.rst
@@ -5,7 +5,7 @@ ksconf unarchive
 ================
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: unarchive
     :nodefault:

diff --git a/docs/source/cmd_xmlformat.rst b/docs/source/cmd_xmlformat.rst
@@ -5,7 +5,7 @@ ksconf xml-format
 
 
 ..  argparse::
-    :module: ksconf.__main__
+    :module: ksconf.cli
     :func: build_cli_parser
     :path: xml-format
     :nodefault:
@@ -50,3 +50,6 @@ To recursively format xml files
 ..  code-block:: sh
 
     find . -path '*/data/ui/views/*.xml' -o -path '*/data/ui/nav/*.xml' | ksconf xml-format -
+
+
+..  include:: common
diff --git a/docs/source/concepts.rst b/docs/source/concepts.rst
@@ -98,4 +98,4 @@ What does Splunk have to say about this?   (From the docs)
 
 .. [SPLKDOC1] https://docs.splunk.com/Documentation/Splunk/7.2.3/Admin/Configurationfiledirectories
 
-.. include:: common
+..  include:: common
diff --git a/docs/source/contrib.rst b/docs/source/contrib.rst
@@ -101,7 +101,7 @@ File path                           Description / purpose
 ``tests/tests/test_cli_CMD.py``     Add new unit test here
 ``docs/source/cmd_CMD.rst``         Command line documentation.  Make sure to include the `argparse` module
 ``ksconf/setup_entrypoints.py``     Add a new entrypoint line here, or the new command won't be registered
-``.pre-commit-hooks.yaml``          If a new command is applicable, add this to the `ksconf pre-commit repo`_.
+``.pre-commit-hooks.yaml``          If a new command is applicable, add this to the `ksconf-pre-commit repo`_.
 ``setup.py``                        Update if there are any new external dependencies
 ``requirements.txt``                Same as above
 ``make_splunk_app``                 If there's new dependencies that need to go into the Splunk app

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -92,4 +92,4 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-.. include:: common
+..  include:: common
diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -300,4 +300,4 @@ OS-specific notes:
 
 
 
-.. include:: common
+..  include:: common