tripleo

Sphinx throws warnings on auto-generated from workbooks docs

Bug #1810707 reported by Radoslaw Smigielski
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
tripleo
In Progress
Low
Radoslaw Smigielski

Bug Description

Workbooks/workflow HTML docs are generated from descriptions and input params taken from workbooks .yaml files by this tool: doc/source/_exts/workbooks.py

Problems are:
 - multiline descriptions are not formatted correctly and generates Sphinx warnings
 - missing line before section "Workflow inputs:" generates Sphinx warnings
 - some workflow descriptions trigger Sphinx warnings

/home/radek/src/openstack/tripleo-common/doc/source/reference/workbooks/baremetal.rst:139: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/radek/src/openstack/tripleo-common/doc/source/reference/workbooks/heat_environments.rst:16: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/radek/src/openstack/tripleo-common/doc/source/reference/workbooks/heat_environments.rst:27: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/radek/src/openstack/tripleo-common/doc/source/reference/workbooks/messaging.rst:16: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/radek/src/openstack/tripleo-common/doc/source/reference/workbooks/messaging.rst:18: WARNING: Unexpected indentation.
/home/radek/src/openstack/tripleo-common/doc/source/reference/workbooks/messaging.rst:26: WARNING: Unexpected indentation.
/home/radek/src/openstack/tripleo-common/doc/source/reference/workbooks/messaging.rst:31: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/radek/src/openstack/tripleo-common/doc/source/reference/workbooks/messaging.rst:32: WARNING: Definition list ends without a blank line; unexpected unindent.
/home/radek/src/openstack/tripleo-common/doc/source/reference/workbooks/swift.rst:16: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/radek/src/openstack/tripleo-common/doc/source/reference/workbooks/swift.rst:28: WARNING: Explicit markup ends without a blank line; unexpected unindent.
looking for now-outdated files... none found

See original description
Radoslaw Smigielski (radoslaw-smigielski)
Changed in tripleo:
assignee: nobody → Radoslaw Smigielski (radoslaw-smigielski)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to tripleo-common (master)

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

Radoslaw Smigielski (radoslaw-smigielski)
description: updated
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Juan Antonio Osorio Robles (juan-osorio-robles)
Changed in tripleo:
importance: Undecided → Low
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to tripleo-common (master)

Reviewed: https://review.openstack.org/628871
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=6ab8c4511d3fff5db3cc192f4de1e96397aafdb4
Submitter: Zuul
Branch: master

commit 6ab8c4511d3fff5db3cc192f4de1e96397aafdb4
Author: Radoslaw Smigielski <email address hidden>
Date: Mon Jan 7 07:23:45 2019 +0100

    Sphinx throws warnings on workbooks descriptions

    Workbooks/workflow HTML docs are generated from descriptions and input params
    taken from workbooks .yaml. Two of the descriptions caused Sphinx to throw
    warnings.

    Change-Id: I1b8842f0bfbcdc011b23489b85a8a22e482a4f88
    Partial-Bug: 1810707

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/628862
Committed: https://git.openstack.org/cgit/openstack/tripleo-common/commit/?id=77998d4316436b3cf97c6d9f7c8b71f8f0701a64
Submitter: Zuul
Branch: master

commit 77998d4316436b3cf97c6d9f7c8b71f8f0701a64
Author: Radoslaw Smigielski <email address hidden>
Date: Mon Jan 7 07:06:41 2019 +0100

    Fix Sphinx warnings on auto generated workbooks docs

    Workbooks/workflow HTML docs are generated from descriptions and input params
    taken from workbooks .yaml files by: doc/source/_exts/workbooks.py

    Problems are:
     - multiline descriptions are not formatted correctly and generates
       Sphinx warnings
     - missing line before section "Workflow inputs:" generates Sphinx warnings

    Change-Id: Ibb40b025ccb9470096da79deb5b5002444474071
    Partial-Bug: 1810707

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

Other bug subscribers

Remote bug watches

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