openstackdocstheme "Previous (<<)" confused/corrupted by autodoc modules

Bug #1701752 reported by Michael Johnson
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstackdocstheme
Confirmed
High
Unassigned

Bug Description

What a project is using the pbr "autodoc_index_modules = True" to generate module documentation, the page after a page that has a link to the modules will have a corrupted "<<" previous navigation link (see the attached image).

If I re-order my top level document such that the "Octavia User" section comes before the "Octavia Contributor" section this issue goes away. It appears to be caused by the last link on the "Octavia Contributor" page being the "* :ref:`modindex`" tag.

This can be viewed on a in review patch: http://docs-draft.openstack.org/47/478947/7/check/gate-octavia-docs-ubuntu-xenial/606bb7e//doc/build/html/user/index.html

Clicking the broken link takes me to the last module page titled "The octavia.version Module"

Revision history for this message
Michael Johnson (johnsom) wrote :
Revision history for this message
Michael Johnson (johnsom) wrote :

The auto-generated file the previous link is pointing to has:

The :mod:`octavia.version` Module
=================================

.. automodule:: octavia.version
  :members:
  :undoc-members:
  :show-inheritance:

Changed in openstack-doc-tools:
importance: Undecided → High
status: New → Confirmed
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Bug attachments

Remote bug watches

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