b0a65514c0
Add a section for where Resource classes will show up in the docs and enter two skeleton pages for how this will look. Later changes will cover the actual member-level documentation of the Resource classes for each service, along with their addition to the TOC. This additionally sets autodoc_member_order globally to "bysource", meaning it'll order the rendered member documentation in the order it was written. The default of alphabetical order by what shows up in __dir__ is not as helpful or as readable as how we've organized the code. Change-Id: Ifcd7cd81ba55ecb429c50680a926d4f8a44ca9a3
OpenStack Python SDK
python-openstacksdk is a new Python library and SDK for
OpenStack clouds. It is very young, and not yet usable, but it's under
active development.
Our goal is to provide a Python library which is:
- Pleasant to use
- Well documented
- Complete (works with any OpenStack project)
Building Documentation
This documentation is written by contributors, for contributors.
The source is maintained in the doc/source/ folder using
reStructuredText
and built by Sphinx
To build the docs locally:
$ python setup.py build_sphinxResults are in the doc/build/html/ directory.
Requirements
- Python 2.6+, Python 3.3+
- pbr
- requests
- iso8601
- stevedore
License
Apache 2.0