Files
openstacksdk/doc/source/index.rst
Monty Taylor 535f2f48ff Merge shade and os-client-config into the tree
This sucks in the git history for both projects, then moves their files
in place. It should not introduce any behavior changes to any of the
existing openstacksdk code, nor to openstack.config and openstack.cloud
- other than the name change.

TODO(shade) comments have been left indicating places where further
integration work should be done.

It should not be assumed that these are the final places for either to
live. This is just about getting them in-tree so we can work with them.

The enforcer code for reasons surpassing understanding does not work
with python setup.py build_sphinx but it does work with sphinx-build
(what?) For now turn it off. We can turn it back on once the build
sphinx job is migrated to the new PTI.

Change-Id: I9523e4e281285360c61e9e0456a8e07b7ac1243c
2017-11-15 09:03:23 -06:00

41 lines
784 B
ReStructuredText

Welcome to the OpenStack SDK!
=============================
This documentation is split into two sections: one for
:doc:`users <users/index>` looking to build applications which make use of
OpenStack, and another for those looking to
:doc:`contribute <contributor/index>` to this project.
For Users
---------
.. toctree::
:maxdepth: 2
users/index
install/index
user/index
.. TODO(shade) merge users/index and user/index into user/index
For Contributors
----------------
.. toctree::
:maxdepth: 2
contributor/index
.. include:: ../../README.rst
General Information
-------------------
General information about the SDK including a glossary and release history.
.. toctree::
:maxdepth: 1
Glossary of Terms <glossary>
Release Notes <releasenotes>