Fix sphinx build errors

ansible · Oct 14, 2024 · 06cbaa9 · 06cbaa9
1 parent 61cb018
commit 06cbaa9
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 3 deletions.
diff --git a/docs/ansible_runner.config.rst b/docs/ansible_runner.config.rst
@@ -7,4 +7,5 @@ Submodules
 ansible_runner.config.runner module
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+.. autoclass:: ansible_runner.config.runner.BaseConfig
 .. autoclass:: ansible_runner.config.runner.RunnerConfig
diff --git a/docs/ansible_runner.rst b/docs/ansible_runner.rst
@@ -25,6 +25,7 @@ ansible_runner.interface module
 
 .. automodule:: ansible_runner.interface
     :members:
+    :exclude-members: init_runner
     :undoc-members:
     :show-inheritance:
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -26,6 +26,10 @@ def _get_version():
 
 
 nitpicky = True
+nitpick_ignore = {
+    ('py:class', '_io.FileIO')
+}
+
 default_role = 'any'  # This catches single backticks (incorrectly) used for inline code formatting
 project = 'ansible-runner'
 copyright = f'2018-{datetime.datetime.today().year}, Red Hat, Inc'

diff --git a/src/ansible_runner/config/_base.py b/src/ansible_runner/config/_base.py
@@ -67,9 +67,9 @@ class BaseConfig:
     """The base configuration object.
 
     This object has multiple initialization responsibilities, including:
-        - guaranteeing the `private_data_dir` directory exists
-        - guaranteeing that `ident` value is set
-        - setting the various work directory attributes based on `private_data_dir`
+        - guaranteeing the 'private_data_dir' directory exists
+        - guaranteeing that 'ident' value is set
+        - setting the various work directory attributes based on 'private_data_dir'
     """
 
     # This MUST be the first field we define to handle the use case where a RunnerConfig object