9b2729cdd5
This change creates a section of the documentation focused on users, holding the guides, API docs, etc. Another change will focus on documentation for contributors. * Installation details were moved straight into the user index. Installation details for contributors will go into that section. * The old usage.rst section was moved into the userguides/ section and will grow into a Connection guide in another change. * The sections were organized according top to bottom in order of likelihood of utility to users. The guides will help people get started, the API docs will help them go from there, and anyone needing to customize lower-level things will have already scrolled through the preceeding sections to get to the end. * In order to see how the Resource docs turn out to be organized, I added pages for Compute and Database resources. We'll need to add them for every service, but I didn't want to overload this change with all of those additions. * Since glossary isn't linked in a TOC anywhere, just mentioned explicitly at the beginning of the user section, I added an exclude for it in the conf.py. It still gets built, but that allows it to not become a warning for being left out of TOCs. Change-Id: If9d1e4726ed14d5b7592c9da00c27591d2a4291c Partial-Bug: 1416553
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