diff options
| author | Julien Danjou <julien@danjou.info> | 2015-05-05 14:21:56 +0200 |
|---|---|---|
| committer | Julien Danjou <julien@danjou.info> | 2015-05-21 15:00:47 -0700 |
| commit | e943f760851d193cc4d808deeef59d1a5f789c03 (patch) | |
| tree | 9605bb4dfefce608319348302eda4926a80cbc7f /doc/source/index.rst | |
| parent | 3cec7c8782d8ccecdf8c3e08b21d9d9342b096da (diff) | |
| download | pbr-e943f760851d193cc4d808deeef59d1a5f789c03.tar.gz | |
builddoc: allow to use fnmatch-style exclusion for autodoc
This allows to use patterns such as heat.tests.* to exlude modules from
autodoc genereation.
Change-Id: Ibfc4161670fd9344da88c4a85a3aea992fcdf519
Diffstat (limited to 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 8b4240c..5da6eba 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -298,7 +298,8 @@ should generate an index of modules using `sphinx-apidoc`. The `autodoc_index_modules` is a boolean option controlling whether pbr should itself generates documentation for Python modules of the project. By default, all found Python modules are included; some of them can be excluded by listing -them in `autodoc_exclude_modules`. +them in `autodoc_exclude_modules`. This list of modules can contains `fnmatch` +style pattern (e.g. `myapp.tests.*`) to exclude some modules. Additional Docs =============== |