API reference can no longer hide whole sections

Bug #1755566 reported by Matt Riedemann
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Cinder
Fix Released
Medium
Sean McGinnis
openstackdocstheme
Invalid
Undecided
Unassigned

Bug Description

This change https://review.openstack.org/#/c/548972/ broke the ability for the API reference to hide entire sections:

https://developer.openstack.org/api-ref/block-storage/v3/

The problem is likely that the response status codes sections are nested incorrectly and are at the same level as the parent API section they are meant to describe.

Revision history for this message
Matt Riedemann (mriedem) wrote :

Actually I'm not sure about the section headers, it might just be a bug in os-api-ref when using rest_status_code and rest_expand_all, the former might break the latter.

Revision history for this message
Sean McGinnis (sean-mcginnis) wrote :

Appears to be the change in title levels due to differences in the inc files. Changing to match the right level used fixes this. Patch forthcoming.

Revision history for this message
Sean McGinnis (sean-mcginnis) wrote :

And thanks to Matt Riedemann for noticing that minor difference.

Changed in openstack-doc-tools:
status: New → Invalid
Changed in cinder:
status: New → Confirmed
importance: Undecided → Medium
assignee: nobody → Sean McGinnis (sean-mcginnis)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to cinder (master)

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

Changed in cinder:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to cinder (master)

Reviewed: https://review.openstack.org/552687
Committed: https://git.openstack.org/cgit/openstack/cinder/commit/?id=a96fad9f3bf01d8482edec6d1a5e3bfa3389df03
Submitter: Zuul
Branch: master

commit a96fad9f3bf01d8482edec6d1a5e3bfa3389df03
Author: Sean McGinnis <email address hidden>
Date: Tue Mar 13 15:57:54 2018 -0500

    Fix api-ref response code title levels

    Using the wrong character resulted in the wrong title level
    being used for the response codes, which in turn caused the
    "detail" show/hide toggle to not be able to hide all of the
    per-endpoint details. This corrects these to be at the correct
    level.

    Also ran into issues after changing them where sphinx was not
    happy with the random title levels. This appears to be due to
    the order processed and whether not earlier included files had
    all subsequent levels. Adding an additional title in our first
    included file resolved that problem.

    Change-Id: I19405778980310f2d6d06eb7b23102f74a3d6e03
    Closes-bug: #1755566

Changed in cinder:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/cinder 13.0.0.0b1

This issue was fixed in the openstack/cinder 13.0.0.0b1 development milestone.

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.