PBR

No new/removed modules when building docs

Bug #1647140 reported by Florian Wilhelm
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
PBR
Confirmed
Medium
Unassigned

Bug Description

When using sphinx-apidoc for the automatic generation of Sphinx sources, i.e. the autodoc_index_modules = False in setup.cfg, added or removed modules files are not included/removed when running "python setup.py docs". This is most likely due to the fact that the tool sphinx-apidoc itself does not regenerate the rst files if the target directory docs/api exists. One has to remove the directory docs/api manually in order to see new included modules or get rid of removed module files. For most users this behavior is annoying and it would be nice to have an PBR option like clean_autodoc in setup.cfg that removes the docs/api directory everytime before calling sphinx-apidoc.

Revision history for this message
Ben Nemec (bnemec) wrote :

As a workaround for this, some projects have started to remove the entire build directory in tox before doing their doc builds. It makes the build take a little longer, but it avoids problems like this.

Changed in pbr:
status: New → Confirmed
importance: Undecided → Medium
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.