Docs for modules in contrib are not generated

[Richard Lee]

Docs for the modules in the contrib folder are not being generated by sphinx: http://docs.openstack.org/developer/heat/

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

commit e476af0dc503eacffe70d8fb3bbebc45532cda0c
Author: Richard Lee <email address hidden>
Date: Thu Jan 23 12:32:59 2014 -0600

    Rename rackspace.rst to contrib.rst

    Partial-Bug: #1271226
    Change-Id: I1b5f848ef7f8da645ea57a0a30e7f9b86a4c866b

[OpenStack Infra (hudson-openstack)]

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

commit bc9a1cc9c1719205312fd5c4ceca52daa2fa1399
Author: Anderson Mesquita <email address hidden>
Date: Fri Jan 24 16:26:50 2014 -0600

    Restructure Rackspace resources

    During doc generation, resources have their own templates and need
    to be separate from non-resource modules. This removes the ``heat``
    ``engine`` and ``plugins`` folders and moves all resources into a
    ``resources`` folder, effectively separating the custom Rackspace
    Client from custom Rackspace resources.

    Partial-Bug: #1271226
    Change-Id: Idbdc8400d30e2e745a2dc1b2d2fa1b7cff50d57b

[OpenStack Infra (hudson-openstack)]

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

commit 5acdabf81dad824128664e49403d26963b21f2f7
Author: Richard Lee <email address hidden>
Date: Thu Jan 23 12:30:46 2014 -0600

    Reorganize docker-plugin for consistency

    Package and Module names shouldn't have dashes in them, since it makes
    it harder to import them (i.e. one cannot use ``import dashed-module``).

    Also, moving docker resource under resources for consistency.

    Partial-Bug: #1271226
    Change-Id: I785b626a99516ebe6444296cf62a78dd96355060

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

commit 416a894f0aa01d72a937eb5af82afe318d97d7c0
Author: Richard Lee <email address hidden>
Date: Thu Jan 23 16:08:54 2014 -0600

    Add Rackspace resources summary to docs

    Add information regarding general use case, dependencies, and README
    info for Rackspace resources in the contrib docs.

    Closes-Bug: #1271226
    Change-Id: I3a57cd5f1e72663bd283d96c07949ff6de23df3a

[OpenStack Infra (hudson-openstack)]

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

commit 07588b3f66ba8683491cc74cc30511e014716939
Author: Anderson Mesquita <email address hidden>
Date: Tue Feb 4 15:19:29 2014 -0600

    Rename Marconi plugin package

    Package and Module names shouldn't have dashes in them, since it
    makes it harder to import them (i.e. one cannot use ``import
    dashed-module``).

    Partial-Bug: #1271226
    Change-Id: I2d3674753bd3fcef284c94911cff3cf9fa22d316

[OpenStack Infra (hudson-openstack)]

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

commit 4e8231e1805ef040d222c44a0170eedd5810b975
Author: Richard Lee <email address hidden>
Date: Fri Feb 7 09:45:49 2014 -0600

    Rename docker_plugin to docker

    Renaming docker to get consistency across contrib package names

    Change-Id: Ia02daa4537cf9103b505c9ee4658c014f38d3f1b
    Partial-Bug: #1271226

[OpenStack Infra (hudson-openstack)]

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

[OpenStack Infra (hudson-openstack)]

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

commit 4ef997e8b72fd4dae4d46ce5644403fb635274c4
Author: Anderson Mesquita <email address hidden>
Date: Fri Feb 7 17:35:58 2014 -0500

    Refactor resource loading functions

    All logic related to resource loading is currently put into
    resource_mapping functions in each resource module and it doesn't
    return the mapping information if the dependencies for a given
    resources are not satisfied.

    This refactors the way resources are loaded, so that the mapping
    information is always available and if the dependencies are not met,
    another function can be used to convey that information to heat:
    available_resource_mapping(). To keep backwards compatibility, if
    available_resource_mapping() is not callable for a given resource
    module, the previous resource_mapping() will be used instead.

    This allows the mapping information to be used in other places, such
    as tests (without the need to hard code the mapping information when
    registering the resource for the tests) or doc generation (to allow
    the resources to be loaded even without their dependencies).

    Related-Bug: #1271226
    Change-Id: Iabd3da70f7ba35e0b43a2409e170be7f41a351a6

[OpenStack Infra (hudson-openstack)]

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

commit fa37be061cc19545550eace9531250e5209bb1be
Author: Anderson Mesquita <email address hidden>
Date: Fri Jan 24 16:44:32 2014 -0600

    Fix resource mapping for Rackspace

    resource_mapping() always returns all existing resource names and
    their classes. available_resource_mapping() takes the dependencies
    into account and only returns the ones whose dependencies have been
    met.

    Partial-Bug: #1271226
    Change-Id: I3a7467e87f7ff81badd51f121ecea98f2924e506

[OpenStack Infra (hudson-openstack)]

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

commit 70f7f72b68f9233a2891e19c8fadd994bbee871a
Author: Anderson Mesquita <email address hidden>
Date: Thu Jan 23 12:40:05 2014 -0600

    Fix resource mapping for Docker

    resource_mapping() always returns all existing resource names and
    their classes. available_resource_mapping() takes the dependencies
    into account and only returns the ones whose dependencies have been
    met.

    Co-Authored-By: Richard Lee <email address hidden>
    Partial-Bug: #1271226
    Change-Id: I3d785d92f1d30a3caf4cb0f7721c66c9dda294c3

[OpenStack Infra (hudson-openstack)]

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

commit 43262f9ebe01b3f529e62ed250da27d059720a4c
Author: Richard Lee <email address hidden>
Date: Thu Jan 23 12:40:57 2014 -0600

    Change Docker resource mapping name

    Removing the OS:: prefix since this is not an OpenStack-provided
    resource. Also remove hardcoded resource mapping name in test.

    Co-Authored-By: Anderson Mesquita <email address hidden>
    Partial-Bug: #1271226
    Change-Id: I5691a08df3700f896ca1fe6efec4487d44617d6d

[OpenStack Infra (hudson-openstack)]

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

commit 8b6220073b30c8777448cdeb9092aa6b6e0a0bcc
Author: Anderson Mesquita <email address hidden>
Date: Thu Jan 23 14:00:30 2014 -0600

    Add Docker resources to docs

    This add a section for Docker resources in the Template Guide page.

    Co-Authored-By: Richard Lee <email address hidden>
    Change-Id: I912fbc8624d93f16e05cb00f886eed6142dd0793
    Partial-Bug: #1271226

[OpenStack Infra (hudson-openstack)]

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

commit 805a73b1e7669550c4ed3c8676b19d5a9d8352ad
Author: Richard Lee <email address hidden>
Date: Fri Feb 21 12:27:22 2014 -0500

    Restructure contrib/ directories

    contrib/ directory does not follow any standards and will make it
    harder to programmatically install plugins on devstack. The current
    structure can also cause namespace collisions when loading them.

    This moves all plugin modules to a folder with the same name under
    their directory (e.g. contrib/rackspace/rackspace), allowing
    requirements, readmes, and other files to be separate from the
    actual code.

    This also helps to avoid namespace collisions when loading all the
    plugins, since all plugins will be under their namespace in the heat
    package. Example:
      heat.engine.plugins
      heat.engine.plugins.docker
      heat.engine.plugins.marconi
      heat.engine.plugins.rackspace

    Since plugin packages are now in a folder one level under contrib/,
    testr.conf is also updated so that all plugins are discovered
    correctly.

    Co-Authored-By: Anderson Mesquita <email address hidden>
    Related-Bug: #1271226
    Change-Id: Ifc8e3ca388253be82471651737da5d399c7cfb98

[OpenStack Infra (hudson-openstack)]

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

commit b8e70c54d6052e237fe2b6f0ba6ef7f2acb0369f
Author: Anderson Mesquita <email address hidden>
Date: Thu Jan 23 12:32:28 2014 -0600

    Generate docs for contrib plugins

    Extend write_autodoc_index to take the contrib plugins into account
    and force load all resources - both built-in and contrib - in
    ext/resources.py.

    Co-Authored-By: Richard Lee <email address hidden>
    Partial-Bug: #1271226
    Change-Id: If93dcae52bc573e2673d7fd76a0db62d5fc68115