diff options
author | Julien Danjou <julien@danjou.info> | 2015-05-06 09:49:18 +0200 |
---|---|---|
committer | Julien Danjou <julien@danjou.info> | 2015-05-21 15:00:47 -0700 |
commit | 3cec7c8782d8ccecdf8c3e08b21d9d9342b096da (patch) | |
tree | d8aae413ce380889a1520c1a9065cbf8a3ab80a7 | |
parent | b72e4467e1332cd441def32328249ace99c21b18 (diff) | |
download | pbr-3cec7c8782d8ccecdf8c3e08b21d9d9342b096da.tar.gz |
doc: add some basic doc about pbr doc options
Change-Id: Iccb0ba35a008596cb63e1d6954bd9cb8fa50ae78
-rw-r--r-- | doc/source/index.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 59fe16f..8b4240c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -288,6 +288,18 @@ installed for `pbr.config.drivers`, one called `plain` which maps to the `Plain` class in `pbr.cfg.driver` and one called `fancy` which maps to the `Fancy` class in `pbr.cfg.driver`. +pbr +--- +The pbr section controls pbr specific options and behaviours. + +The `autodoc_tree_index_modules` is a boolean value controlling whether pbr +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`. + Additional Docs =============== |