diff options
author | Jenkins <jenkins@review.openstack.org> | 2015-06-07 04:06:12 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2015-06-07 04:06:12 +0000 |
commit | d8ee71542efcb0e309e6c75c33b11c45127ede48 (patch) | |
tree | 2b02d631fb94d6a16b9a87ee0ee22352b3abfcd3 | |
parent | 0593f600a442643a6f10ec2bcc0598b3b82e2859 (diff) | |
parent | 3cec7c8782d8ccecdf8c3e08b21d9d9342b096da (diff) | |
download | pbr-d8ee71542efcb0e309e6c75c33b11c45127ede48.tar.gz |
Merge "doc: add some basic doc about pbr doc options"
-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 62c5e95..3045414 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -292,6 +292,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 =============== |