Doc generation for contrib plugins cannot be re-enabled

Bug #1403897 reported by andersonvom
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Heat
Fix Released
Undecided
andersonvom

Bug Description

The following error gets thrown when re-enabling doc generation for contrib plugins:

Exception occurred:
  File ".../.pyenv/versions/2.7.6/lib/python2.7/site-packages/pbr/core.py", line 100, in pbr
    'The setup.cfg file %s does not exist.' % path)
DistutilsFileError: The setup.cfg file .../heat/doc/setup.cfg does not exist.
The full traceback has been saved in /var/folders/8z/5qrt0g8s1z7ckltykybvs_4w0000gp/T/sphinx-err-s73peL.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://bitbucket.org/birkenfeld/sphinx/issues/>. Thanks!
make: *** [html] Error 1

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to heat (master)

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

Changed in heat:
assignee: nobody → andersonvom (andersonvom)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to heat (master)

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

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

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

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

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to heat (master)

Reviewed: https://review.openstack.org/142792
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=4d522fa55132807a7edaa5c090c1e8c7f4019ec8
Submitter: Jenkins
Branch: master

commit 4d522fa55132807a7edaa5c090c1e8c7f4019ec8
Author: Anderson Mesquita <email address hidden>
Date: Thu Dec 18 08:45:51 2014 -0500

    Fix doc generation for contrib resources

    Since we shouldn't require contrib resources to be installed in order to
    generate documentation, this adds an exception to the plugin loader so
    that it doesn't try to load the setup.py files that can be found inside
    each plugin directory inside contrib/

    Closes-Bug: 1403897
    Change-Id: Id6ece4379599925dd17d22cef401c8d667a0ac51

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

Reviewed: https://review.openstack.org/142793
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=c9082144bc9fbc7ef793d8a2ea84abbe7086dd41
Submitter: Jenkins
Branch: master

commit c9082144bc9fbc7ef793d8a2ea84abbe7086dd41
Author: Anderson Mesquita <email address hidden>
Date: Thu Dec 18 08:57:21 2014 -0500

    Re-enable doc generation for contrib plugins

    This re-enables doc generation for contrib plugins and removes legacy
    code no longer needed because of stevedore.

    Related-Bug: 1403897
    Change-Id: Ia51cb7c8b0c375d2a430d45b9ece50eb67271788

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

Reviewed: https://review.openstack.org/142794
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=c7627822847f9c5a45ea0d0a30e91347df6a9a5e
Submitter: Jenkins
Branch: master

commit c7627822847f9c5a45ea0d0a30e91347df6a9a5e
Author: Anderson Mesquita <email address hidden>
Date: Tue Dec 16 14:39:37 2014 -0800

    Remove warnings when generating docs

    Improve docstrings so that syntax warnings are no longer displayed when
    generating docs.

    Related-Bug: 1403897
    Change-Id: I0163bc7f83e00f9077fc78e638173df2124580dd

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

Reviewed: https://review.openstack.org/142795
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=973b7ea6b747c5a8b7e5b5511ea350448625a7f6
Submitter: Jenkins
Branch: master

commit 973b7ea6b747c5a8b7e5b5511ea350448625a7f6
Author: Anderson Mesquita <email address hidden>
Date: Tue Dec 16 15:10:18 2014 -0800

    Fix doc generation for Rackspace::Cloud::Network

    Since contrib plugins may not be installed at the time the docs are
    generated, the resource_mapping function needs to return all resource
    types defined by the resource module. To selectively load such resource
    types - based on requirements being met, for instance, the
    available_resource_mapping function should be used instead.

    This makes the necessary changes to Rackspace::Cloud::Network so that
    its docs are generated correctly.

    Related-Bug: 1403897
    Change-Id: I7c12c055924e7a16a5b9cc573d91c12089a2395d

Thierry Carrez (ttx)
Changed in heat:
milestone: none → kilo-2
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in heat:
milestone: kilo-2 → 2015.1.0
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.