PBR

literal text in sidebar TOC does not wrap

Bug #1702893 reported by Doug Hellmann
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
PBR
Confirmed
Medium
Unassigned
openstackdocstheme
Confirmed
Medium
Unassigned

Bug Description

Some of the auto-generated content, especially the class API references, include literal text in the table of contents entries. Those entries do not wrap in the sidebar that shows the table of contents (see http://docs-draft.openstack.org/88/479988/1/check/gate-ironic-python-agent-docs-ubuntu-xenial/ab855ca//doc/build/html/ for an example).

We either need to deal with the sidebar width, allow the text to wrap, or have pbr not generate the text using literal markup.

Revision history for this message
Anne Gentle (annegentle) wrote :

I want to say we have fixed this in the past for some of the API references, by adding logic that put in a soft return at symbols such as underbar or period. Might work for this particular problem.

Changed in openstack-doc-tools:
status: New → Confirmed
importance: Undecided → Medium
Ben Nemec (bnemec)
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.