python setup.py build_sphinx reports: build succeeded, 1 warning

[yatin]

Relevant log: http://logs.openstack.org/97/491297/2/gate/gate-sahara-docs-ubuntu-xenial/32514e2/console.html#_2017-08-10_19_38_31_317933

Reason is: 'help' attr is missing for publisher_id:- https://github.com/openstack/sahara/blob/master/sahara/utils/notification/sender.py#L36

Other info, not related to fixing bug but it's good to note here:-
As warning-is-error is enabled in sahara(https://github.com/openstack/sahara/blob/master/setup.cfg#L85) warning as seen in logs should be reported as error but it's not.
sahara is using oslo_sphinx.spinxconfiggen extension: https://github.com/openstack/sahara/blob/master/doc/source/conf.py#L40-L51

To me it looks there is some issue in how sphinx handles log warnings and how oslo_config is emitting log warnings:-
[0] sphinx suppresswarning code: https://github.com/sphinx-doc/sphinx/blob/1.6.3/sphinx/util/logging.py#L307-L320
[1] oslo_config generator code: https://github.com/openstack/oslo.config/blob/4.0.0/oslo_config/generator.py#L209-L210

sphinx need type, subtype attr at [0] but oslo_config is using python's logging module(at [1]) which doesn't set type, subtype,
so type, subtype would always be None and WarningSuppressor will return True always

[Luigi Toscano (ltoscano)]

So part of the error seems to be related to sphinx and/or oslo_config; would you try to report an issue to oslo_config, or at least assign this bug to oslo.config too?

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/493620
Committed: https://git.openstack.org/cgit/openstack/sahara/commit/?id=8b3843b6173ec51bc7dea6057bd3ca50224d615a
Submitter: Jenkins
Branch: master

commit 8b3843b6173ec51bc7dea6057bd3ca50224d615a
Author: Luigi Toscano <email address hidden>
Date: Mon Aug 14 19:36:43 2017 +0200

    Cleanup the last warning on doc building (html and man)

    - Quote the hyphens so that they are shown unchanged
    Closes-Bug: #1710628

    - Restructure the Feature-by-Plugin table, simplifying
      it a bit so that the generation of man pages does not
      issue a warning (and so that the looks on the HTML
      version is still acceptable). It looks like the
      man page generator is more limited.
    Closes-Bug: #1710608

    - Add the missing help entry to a configuration key,
      removing a warning
    Closes-Bug: #1710673

    Change-Id: I010b4a9114e6b21068b6d48243ac0a292a3bb497

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: stable/pike
Review: https://review.openstack.org/493670

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/493670
Committed: https://git.openstack.org/cgit/openstack/sahara/commit/?id=04661996b378eea728d3aed5ca2cccdf42c0add3
Submitter: Jenkins
Branch: stable/pike

commit 04661996b378eea728d3aed5ca2cccdf42c0add3
Author: Luigi Toscano <email address hidden>
Date: Mon Aug 14 19:36:43 2017 +0200

    Cleanup the last warning on doc building (html and man)

    - Quote the hyphens so that they are shown unchanged
    Closes-Bug: #1710628

    - Restructure the Feature-by-Plugin table, simplifying
      it a bit so that the generation of man pages does not
      issue a warning (and so that the looks on the HTML
      version is still acceptable). It looks like the
      man page generator is more limited.
    Closes-Bug: #1710608

    - Add the missing help entry to a configuration key,
      removing a warning
    Closes-Bug: #1710673

    Change-Id: I010b4a9114e6b21068b6d48243ac0a292a3bb497
    (cherry picked from commit 8b3843b6173ec51bc7dea6057bd3ca50224d615a)

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/sahara 7.0.0.0rc2 release candidate.

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/sahara 8.0.0.0b1 development milestone.