After digging in pbr and sphinx source code for a day to figure out
what I was doing wrong, let's update the pbr docs with respect to
building docs using the autodoc features in pbr.
Specifically, document the autodoc_tree_excludes and warnerrors
options and point out that you will probably need to set the
exclude_patterns options in your sphinx config when excluding
modules from the docs build and warnerrors=True. Also provide
some links to the Sphinx docs for more details.
Reviewed: https:/ /review. openstack. org/199609 /git.openstack. org/cgit/ openstack- dev/pbr/ commit/ ?id=07292c2d843 7ca3e10669038d1 036f6903e54c80
Committed: https:/
Submitter: Jenkins
Branch: master
commit 07292c2d8437ca3 e10669038d1036f 6903e54c80
Author: Matt Riedemann <email address hidden>
Date: Wed Jul 8 07:35:20 2015 -0700
Add more documentation around building docs
After digging in pbr and sphinx source code for a day to figure out
what I was doing wrong, let's update the pbr docs with respect to
building docs using the autodoc features in pbr.
Specifically, document the autodoc_ tree_excludes and warnerrors patterns options in your sphinx config when excluding
options and point out that you will probably need to set the
exclude_
modules from the docs build and warnerrors=True. Also provide
some links to the Sphinx docs for more details.
Related-Bug: #1260495
Related-Bug: #1472276
Change-Id: Ib43830d08a156f 37a3763ad2807d5 c1f4cdbe3fe