pulumi/sdk/python/lib
Sean Gillespie 87b8b4dcda
Clean up documentation for Python SDK (#2398)
* Clean up documentation for Python SDK

The Python SDK currently does a couple of bad things that make it
difficult to generate documentation:

1. It "wildcard-imports" submodules without each module specifying an
__all__ member
2. Documentation strings don't have a consistent format
3. Documentation strings are in Markdown and not reStructuredText

To remedy this, this commit addresses 1 by explicitly specifying which
members are being exported from submodules, so that we can see in one
place exactly what the public surface area of the pulumi package is. For
2 and 3, this commit fixes a large number of documentation strings to
contain metadata tags that Sphinx is capable of reading. This allows us
to generate high-quality documentation directly from the source without
having to manually parse docstrings.

* Please pylint
2019-01-31 10:36:03 -08:00
..
pulumi Clean up documentation for Python SDK (#2398) 2019-01-31 10:36:03 -08:00
test Follow up on #2369 (#2397) 2019-01-28 17:38:16 -08:00
MANIFEST.in Include README in pypi package 2018-07-13 18:19:42 -07:00
setup.py Remove dependency on Six (#2372) 2019-01-18 13:59:37 -08:00