Group help text is output multiple times during sphinx docs generation

Bug #1782253 reported by Matt Riedemann
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
oslo.config
Fix Released
Medium
Stephen Finucane

Bug Description

I've noticed that config option group help text is dumped multiple times in the rst-generated docs:

https://docs.openstack.org/nova/latest/configuration/config.html#upgrade-levels

It's not a problem in queens:

https://docs.openstack.org/nova/queens/configuration/config.html#upgrade-levels

So it must be a regression in rocky.

It's also not a problem in the sample file that's generated:

https://docs.openstack.org/nova/latest/configuration/sample-config.html

Changed in oslo.config:
importance: Undecided → Medium
assignee: nobody → Stephen Finucane (stephenfinucane)
status: New → Confirmed
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to oslo.config (master)

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

Changed in oslo.config:
status: Confirmed → In Progress
Changed in oslo.config:
assignee: Stephen Finucane (stephenfinucane) → Matt Riedemann (mriedem)
Matt Riedemann (mriedem)
Changed in oslo.config:
assignee: Matt Riedemann (mriedem) → Stephen Finucane (stephenfinucane)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to oslo.config (master)

Reviewed: https://review.openstack.org/583523
Committed: https://git.openstack.org/cgit/openstack/oslo.config/commit/?id=b596dc2d12aeacc63d233e96dde5f7b12d57983d
Submitter: Zuul
Branch: master

commit b596dc2d12aeacc63d233e96dde5f7b12d57983d
Author: Stephen Finucane <email address hidden>
Date: Wed Jul 18 09:46:41 2018 +0100

    sphinxext: Stop emitting lines multiple times

    A typo resulted in us dumping the help text for opts as many times as
    there were lines in the group help text. Resolve this.

    Change-Id: I7a6506235834022fa76588e55ec60921b1ae673f
    Signed-off-by: Stephen Finucane <email address hidden>
    Closes-Bug: #1782253

Changed in oslo.config:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/oslo.config 6.5.0

This issue was fixed in the openstack/oslo.config 6.5.0 release.

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.