autodoc extension: add autodoc_mock_imports config value

1 files changed, 10 insertions, 0 deletions

diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst
index c92fe0c4..c37328f5 100644
--- a/doc/ext/autodoc.rst
+++ b/doc/ext/autodoc.rst
@@ -195,6 +195,10 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
 
      .. versionadded:: 1.2
 
+   * Add a list of modules in the :confval:`autodoc_mock_imports` to prevent
+     import errors to halt the building process when some external dependencies
+     are not importable at build time.
+
 
 .. rst:directive:: autofunction
                    autodata
@@ -335,6 +339,12 @@ There are also new config values that you can set:
 
    .. versionadded:: 1.1
 
+.. confval:: autodoc_mock_imports
+
+   This value contains a list of modules to be mocked up. This is useful when
+   some external dependencies are not met at build time and break the building
+   process.
+
 
 Docstring preprocessing
 -----------------------