Using literals in titles breaks pagination

Bug #1702328 reported by Stephen Finucane
14
This bug affects 2 people
Affects Status Importance Assigned to Milestone
openstackdocstheme
New
High
Unassigned
openstackdocstheme
Fix Released
High
Stephen Finucane

Bug Description

If you use a ``literal`` in a title, it breaks the pagination links. For example:

    http://docs-draft.openstack.org/36/480136/1/check/gate-python-novaclient-docs-ubuntu-xenial/2d7d06c//doc/build/html/reference/index.html

This could be something that's not allowed with Sphinx, but I doubt it. For reference, the old oslosphinx theme didn't include these pagination markers so the issue didn't occur:

    http://docs-draft.openstack.org/35/480135/1/check/gate-python-novaclient-docs-ubuntu-xenial/da26390//doc/build/html/reference/index.html

affects: openstack-doc-tools → openstackdocstheme
summary: - Using literals in titles breaks pagination for openstackdocstheme
+ Using literals in titles breaks pagination
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstackdocstheme (master)

Fix proposed to branch: master
Review: https://review.openstack.org/480242

Changed in openstack-doc-tools:
assignee: nobody → Stephen Finucane (stephenfinucane)
status: New → In Progress
Changed in openstackdocstheme:
importance: Undecided → High
Changed in openstack-doc-tools:
importance: Undecided → High
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstackdocstheme (master)

Reviewed: https://review.openstack.org/480242
Committed: https://git.openstack.org/cgit/openstack/openstackdocstheme/commit/?id=d727e522b910e29b245d394cb8199a67477dd157
Submitter: Jenkins
Branch: master

commit d727e522b910e29b245d394cb8199a67477dd157
Author: Stephen Finucane <email address hidden>
Date: Tue Jul 4 16:48:49 2017 +0100

    Strip tags from navigation prev, next titles

    Per the Sphinx documentations:

      next - The next document for the navigation. This variable is either
      false or has two attributes link and title. The title contains HTML
      markup.

      prev - Like next, but for the previous page.

    If using the title value inside an element attribute, we need to ensure
    the HTML tags mentioned above are stripped. Failure to do so results in
    corrupted output.

    Change-Id: I5fde1e6fc4d7966fcd3e767c79535202f3b41a71
    Closes-Bug: #1702328

Changed in openstack-doc-tools:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/openstackdocstheme 1.13.0

This issue was fixed in the openstack/openstackdocstheme 1.13.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

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