Add documentation for RunnerConfig

ansible · Dec 2, 2021 · ee68b4f · ee68b4f
1 parent 3c43d1a
commit ee68b4f
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/docs/ansible_runner.config.rst b/docs/ansible_runner.config.rst
@@ -0,0 +1,10 @@
+ansible_runner.config package
+================================
+
+Submodules
+----------
+
+ansible_runner.config.runner module
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autoclass:: ansible_runner.config.runner.RunnerConfig
diff --git a/docs/ansible_runner.rst b/docs/ansible_runner.rst
@@ -7,6 +7,7 @@ Subpackages
 .. toctree::
 
     ansible_runner.callbacks
+    ansible_runner.config
     ansible_runner.display_callback
 
 Submodules

diff --git a/docs/conf.py b/docs/conf.py
@@ -182,7 +182,4 @@ def _get_version():
     ('py:class', 'ansible.plugins.callback.default.CallbackModule'),
     ('py:class', 'display_callback.module.AWXDefaultCallbackModule'),
     ('py:class', 'display_callback.module.AWXMinimalCallbackModule'),
-
-    # FIXME: Undocumented classes referenced explicitly in the RST documents:
-    ('py:class', 'ansible_runner.runner_config.RunnerConfig'),
 ]
diff --git a/docs/python_interface.rst b/docs/python_interface.rst
@@ -365,5 +365,5 @@ The helper methods are just one possible entrypoint, extending the classes used
 
 Show:
 
-* How :class:`Runner Config <ansible_runner.runner_config.RunnerConfig>` is used and how overriding the methods and behavior can work
+* How :class:`Runner Config <ansible_runner.config.runner.RunnerConfig>` is used and how overriding the methods and behavior can work
 * Show how custom cancel and status callbacks can be supplied.