From 6f68800dceb90e679466df11aed58cbd70c8c57e Mon Sep 17 00:00:00 2001 From: Sam Doran Date: Wed, 1 Dec 2021 17:25:30 -0500 Subject: [PATCH] Add documentation for RunnerConfig --- docs/ansible_runner.config.rst | 10 ++++++++++ docs/ansible_runner.rst | 1 + docs/conf.py | 3 --- docs/python_interface.rst | 2 +- 4 files changed, 12 insertions(+), 4 deletions(-) create mode 100644 docs/ansible_runner.config.rst diff --git a/docs/ansible_runner.config.rst b/docs/ansible_runner.config.rst new file mode 100644 index 000000000..9f145e4e7 --- /dev/null +++ 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 index 16751b66d..baf6391aa 100644 --- 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 index f386ee746..99b83dce6 100644 --- 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 index 21bb85add..5f178465f 100644 --- a/docs/python_interface.rst +++ b/docs/python_interface.rst @@ -310,5 +310,5 @@ The helper methods are just one possible entrypoint, extending the classes used Show: -* How :class:`Runner Config ` is used and how overriding the methods and behavior can work +* How :class:`Runner Config ` is used and how overriding the methods and behavior can work * Show how custom cancel and status callbacks can be supplied.