diff options
| author | Georg Brandl <georg@python.org> | 2014-01-19 10:31:15 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2014-01-19 10:31:15 +0100 |
| commit | 005e3af772ef288af4a3cc029c4e9a8ff00d2ca0 (patch) | |
| tree | bfa7571ce91ca4a5176bbef8cc3f8384469c6f32 /doc/ext | |
| parent | a0f2548e011d7bca14ed0b8f148c47040d620227 (diff) | |
| parent | 10e786edac3809660e9129fe53f5e7e05cc9429e (diff) | |
| download | sphinx-005e3af772ef288af4a3cc029c4e9a8ff00d2ca0.tar.gz | |
Merged in guibog/sphinx2 (pull request #184)
autodoc extension: add autodoc_mock_imports config value
Diffstat (limited to 'doc/ext')
| -rw-r--r-- | doc/ext/autodoc.rst | 10 |
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 ----------------------- |