"Field list ends without a blank line; unexpected unindent."

[YAMAMOTO Takashi]

mysterious errors from sphinx.
"Field list ends without a blank line; unexpected unindent."

with sphinx 1.7.4
eg.
http://logs.openstack.org/88/555788/6/check/build-openstack-sphinx-docs/fdc32f3/job-output.txt.gz

2018-05-13 14:22:06.176410 | ubuntu-xenial | Warning, treated as error:
2018-05-13 14:22:06.176967 | ubuntu-xenial | /home/zuul/src/git.openstack.org/openstack/networking-midonet/midonet/neutron/db/l3_db_midonet.py:docstring of midonet.neutron.db.l3_db_midonet.MidonetL3DBMixin.get_router_for_floatingip:8:Field list ends without a blank line; unexpected unindent.

it used to work with sphinx 1.6.5
eg.
http://logs.openstack.org/88/555788/6/check/build-openstack-sphinx-docs/9c8370a/job-output.txt.gz

[YAMAMOTO Takashi (yamamoto)]

https://review.openstack.org/568248 requirements

[Matthew Thode (prometheanfire)]

do we need an exclusion on 1.7.4? does all of 1.7 fail? can we expect 1.7 (or 1.8) to work at some point or will openstack have to make changes?

[YAMAMOTO Takashi (yamamoto)]

Matthew,

I have tried a few of 1.7.x versions but all failed in the same way.

[Matthew Thode (prometheanfire)]

Can we update docs to not fail? We wish to move to 1.7.5 soon (now, maybe)

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: master
Review: https://review.openstack.org/578287

[OpenStack Infra (hudson-openstack)]

Change abandoned by YAMAMOTO Takashi (<email address hidden>) on branch: master
Review: https://review.openstack.org/578287
Reason: merged into https://review.openstack.org/#/c/574991/

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/574991
Committed: https://git.openstack.org/cgit/openstack/networking-midonet/commit/?id=5e82157f3cfcd437e0716356df0cfc06c575e29b
Submitter: Zuul
Branch: master

commit 5e82157f3cfcd437e0716356df0cfc06c575e29b
Author: Andrey Kurilin <email address hidden>
Date: Wed Jun 13 09:00:04 2018 +0300

    Port rally plugins to use proper modules

    Sometime ago, all OpenStack related stuff moved from the main repository
    to the separate one - https://github.com/openstack/rally-openstack .
    All further development and maintance will be done only in a new
    repository. As for first major release, the structure is not changed, so
    only imports should be changed.

    This commit includes the following unrelated change to
    pass the gate.
    ----------------------------------------
    Add dummy docstrings to avoid Sphinx 1.7.x warnings

    We need to workaround this locally because:
    - It's unclear how long os-vif patch [1] will take
      to be merged.
    - While Neutron patch [2] has been merged, docs build on
      gate is using released versions of dependencies.

    The idea was taken from keystone. [3]

    [1] https://review.openstack.org/#/c/577028/
    [2] https://review.openstack.org/#/c/577029/
    [3] https://review.openstack.org/#/c/578121/

    Related-Bug: #1771092
    Change-Id: I2d125ce2251473f896fc251b8fa51cfa29721850
    ----------------------------------------

    Co-Authored-By: YAMAMOTO Takashi <email address hidden>
    Depends-On: I3446ccd5a36cb686282e85a9ea210d1723da1fef
    Change-Id: I796e247bcbafc9c5b6d14e30a52e936b16157b8d

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/queens
Review: https://review.openstack.org/579504

[OpenStack Infra (hudson-openstack)]

Change abandoned by YAMAMOTO Takashi (<email address hidden>) on branch: stable/queens
Review: https://review.openstack.org/579504
Reason: merged into https://review.openstack.org/#/c/572242/

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/572242
Committed: https://git.openstack.org/cgit/openstack/networking-midonet/commit/?id=ae2ed9a6dff37d9b04525643c8fe8dc76766a225
Submitter: Zuul
Branch: stable/queens

commit ae2ed9a6dff37d9b04525643c8fe8dc76766a225
Author: YAMAMOTO Takashi <email address hidden>
Date: Mon Jun 4 19:07:27 2018 +0900

    Fix sphinx-docs job

    build-openstack-sphinx-docs jobs fail on all branches due to the new
    pip version 10 introduces some previously Warning as Error: in case of
    calling "pip install" without any package name, the command fails.
    tox_install.sh is called during docs job without any package passed to pip.

    This patch is necessary until the tox_install.sh removal [1] is merged in.

    [1] https://review.openstack.org/#/c/555788

    Note: This commit includes the following unrelated changes
    to pass the gate.
    (Actually I2d125ce2251473f896fc251b8fa51cfa29721850 might not
    be necessary on this branch. But I included it as it was a part
    of the original commit on master.)
    ----------------------------------------
    Disable failing style checks (W503, E402) for now.

    I (yamamoto) guess they are new with pycodestyle 2.4.0.

    Related-Bug: #1762795
    Change-Id: Ib35d0718bf1410dc8e5c10bb185a00837f2d8b52
    ----------------------------------------
    Update UPPER_CONSTRAINTS_FILE for stable/queens

    The new stable upper-constraints file is only available
    after the openstack/requirements repository is branched.
    This will happen around the RC1 timeframe.

    Recheck and merge this change once the requirements
    repository has been branched.

    The CI system will work with this patch before the requirements
    repository is branched because zuul configues the job to run
    with a local copy of the file and defaults to the master branch.
    However, accepting the patch will break the test configuration
    on developers' local systems, so please wait until after the
    requirements repository is branched to merge the patch.

    Change-Id: Ib8493a9a2ec30cafa70a67a6f5fd1fee29432ad7
    ----------------------------------------
    Port rally plugins to use proper modules

    Sometime ago, all OpenStack related stuff moved from the main repository
    to the separate one - https://github.com/openstack/rally-openstack .
    All further development and maintance will be done only in a new
    repository. As for first major release, the structure is not changed, so
    only imports should be changed.

    Change-Id: I796e247bcbafc9c5b6d14e30a52e936b16157b8d
    (cherry picked from commit 5e82157f3cfcd437e0716356df0cfc06c575e29b)
    ----------------------------------------
    Add dummy docstrings to avoid Sphinx 1.7.x warnings

    We need to workaround this locally because:
    - It's unclear how long os-vif patch [1] will take
      to be merged.
    - While Neutron patch [2] has been merged, docs build on
      gate is using released versions of dependencies.

    The idea was taken from keystone. [3]

    [1] https://review.openstack.org/#/c/577028/
    [2] https://review.openstack.org/...

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/pike
Review: https://review.openstack.org/582607

[OpenStack Infra (hudson-openstack)]

Related fix proposed to branch: stable/ocata
Review: https://review.openstack.org/590421

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/590421
Committed: https://git.openstack.org/cgit/openstack/networking-midonet/commit/?id=abd9ea280042b1dd1bc76bdff9aa05b7a284dfdb
Submitter: Zuul
Branch: stable/ocata

commit abd9ea280042b1dd1bc76bdff9aa05b7a284dfdb
Author: YAMAMOTO Takashi <email address hidden>
Date: Mon Jun 4 19:07:27 2018 +0900

    Fix sphinx-docs job

    build-openstack-sphinx-docs jobs fail on all branches due to the new
    pip version 10 introduces some previously Warning as Error: in case of
    calling "pip install" without any package name, the command fails.
    tox_install.sh is called during docs job without any package passed to pip.

    Note: This commit includes the following unrelated changes
    to pass the gate.
    (Actually I2d125ce2251473f896fc251b8fa51cfa29721850 might not
    be necessary on this branch. But I included it as it was a part
    of the original commit on master.)
    ----------------------------------------
    Pin rally to 0.12.1

    Rally plugin after version 0.12.1 installs the new and latest
    rally-openstack, which has higher requirements of packages and is not
    constrained by pike's upper-constraints.txt during installation. This
    causes problem on stable/pike and older stable branches: keystone
    service is not able to start (ContextualVersionConflict, see
    screen-keystone.txt)

    The patch that introduced the new behaviour:
    https://review.openstack.org/#/c/575064/4/devstack/lib/rally

    Backport Note(yamamoto): Applied to rally-v2 job too.
    ----------------------------------------
    Disable failing style checks (W503, E402) for now.

    I (yamamoto) guess they are new with pycodestyle 2.4.0.

    Related-Bug: #1762795
    Change-Id: Ib35d0718bf1410dc8e5c10bb185a00837f2d8b52
    ----------------------------------------
    Add dummy docstrings to avoid Sphinx 1.7.x warnings

    We need to workaround this locally because:
    - It's unclear how long os-vif patch [1] will take
      to be merged.
    - While Neutron patch [2] has been merged, docs build on
      gate is using released versions of dependencies.

    The idea was taken from keystone. [3]

    [1] https://review.openstack.org/#/c/577028/
    [2] https://review.openstack.org/#/c/577029/
    [3] https://review.openstack.org/#/c/578121/

    Related-Bug: #1771092
    Change-Id: I2d125ce2251473f896fc251b8fa51cfa29721850
    ----------------------------------------

    Conflicting file:
      tox.ini - from upper-constraints we need stable/ocata here, which is
          already set
      rally-jobs/plugins/network_plugin.py - because rally has to be pinned,
          the "Port rally plugins to use proper modules" part of the
          backport has to be left out
      midonet/neutron/db/l3_db_midonet.py - changed between ocata and pike
      midonet/os_vif/vif_midonet.py - new file in pike, so removed

    Co-Authored-By: eeldill <email address hidden>
    Co-Authored-By: Andrey Kurilin <email address hidden>
    Co-Authored-By: OpenStack Release Bot <email address hidden>
    Co-Authored-By: YAMAMOTO Takashi <email address hidden>
   ...

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/requirements rocky-eol release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/requirements stein-eol release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/requirements yoga-eom release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/requirements train-eol release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/requirements ussuri-eol release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/requirements victoria-eom release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/requirements wallaby-eom release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/requirements xena-eom release.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/requirements zed-eom release.