Expand index toctree to two levels

Bumping the depth up to two levels gives a little more information about
what's contained in the sections, and with the contributing headers
adjusted, makes for a better index page.

Change-Id: I485c31b1c68d879775d4966728bd7c96a1c28e6a
This commit is contained in:
Brian Curtin
2014-11-13 17:35:30 -06:00
parent 84c5ddddef
commit fc4623dc00
2 changed files with 18 additions and 17 deletions

View File

@@ -1,5 +1,6 @@
Welcome! ============
======== Contributing
============
python-openstacksdk is a Stackforge project, mirrored on `GitHub`_. Bugs and python-openstacksdk is a Stackforge project, mirrored on `GitHub`_. Bugs and
Blueprints are handled on `Launchpad`_. Code reviews are hosted on `Gerrit`_. Blueprints are handled on `Launchpad`_. Code reviews are hosted on `Gerrit`_.
@@ -9,16 +10,16 @@ Blueprints are handled on `Launchpad`_. Code reviews are hosted on `Gerrit`_.
.. _Gerrit: https://review.openstack.org/#/q/project:stackforge/python-openstacksdk,n,z .. _Gerrit: https://review.openstack.org/#/q/project:stackforge/python-openstacksdk,n,z
Getting Setup Getting Setup
============= -------------
Python Python
------ ******
The python-openstacksdk project supports Python versions 2.6, 2.7, 3.3+, and The python-openstacksdk project supports Python versions 2.6, 2.7, 3.3+, and
pypy, so you'll need to have at least one of those to get started. pypy, so you'll need to have at least one of those to get started.
virtualenv virtualenv
---------- **********
Rather than installing the project's dependencies into your system-wide Python Rather than installing the project's dependencies into your system-wide Python
installation, you should create a virtual environment for this project.:: installation, you should create a virtual environment for this project.::
@@ -30,7 +31,7 @@ installation, you should create a virtual environment for this project.::
(sdk)$ (sdk)$
tox tox
--- ***
We use `tox <https://tox.readthedocs.org>`_ as our test runner, as it provides We use `tox <https://tox.readthedocs.org>`_ as our test runner, as it provides
the ability to run your test against multiple versions. Going back to the the ability to run your test against multiple versions. Going back to the
@@ -48,7 +49,7 @@ environment to run.::
(sdk)$ tox -e py33 (sdk)$ tox -e py33
Using the code Using the code
-------------- **************
To run the examples or otherwise use the SDK within your environment, you'll To run the examples or otherwise use the SDK within your environment, you'll
need to get the project's dependencies.:: need to get the project's dependencies.::
@@ -60,7 +61,7 @@ need to get the project's dependencies.::
Project Layout Project Layout
============== --------------
The code is laid out in the following structure. This example shows files The code is laid out in the following structure. This example shows files
relevant to working with code for the compute service's servers.:: relevant to working with code for the compute service's servers.::
@@ -85,7 +86,7 @@ relevant to working with code for the compute service's servers.::
test_server.py test_server.py
Session Session
------- *******
The :class:`openstack.session.Session` manages an authenticator, The :class:`openstack.session.Session` manages an authenticator,
transport, and user preferences. It exposes methods corresponding to transport, and user preferences. It exposes methods corresponding to
@@ -121,7 +122,7 @@ follows a
that isn't suitable for this library. that isn't suitable for this library.
Resource Resource
-------- ********
The :class:`openstack.resource.Resource` base class is the building block The :class:`openstack.resource.Resource` base class is the building block
of any service implementation. ``Resource`` objects correspond to the of any service implementation. ``Resource`` objects correspond to the
@@ -162,7 +163,7 @@ to support the fact that multiple ``Server``\s can be returned, and each
is identified with a singular noun in the response. is identified with a singular noun in the response.
Proxy Proxy
----- *****
Each service implements a ``Proxy`` class, within the Each service implements a ``Proxy`` class, within the
``openstack/<program_name>/vX/_proxy.py`` module. For example, the v2 compute ``openstack/<program_name>/vX/_proxy.py`` module. For example, the v2 compute
@@ -184,7 +185,7 @@ under construction, as we figure out the best way to implement them in a
way which will apply nicely across all of the services. way which will apply nicely across all of the services.
Connection Connection
---------- **********
The :class:`openstack.connection.Connection` class builds atop a ``Session`` The :class:`openstack.connection.Connection` class builds atop a ``Session``
object, and provides a higher level interface constructed of ``Proxy`` object, and provides a higher level interface constructed of ``Proxy``
@@ -199,17 +200,17 @@ corresponding ``Proxy`` object, the high-level interface to your service
should now be exposed. should now be exposed.
Contacting the Team Contacting the Team
=================== -------------------
IRC IRC
--- ***
The developers of this project are available in the The developers of this project are available in the
`#openstack-sdks <http://webchat.freenode.net?channels=%23openstack-sdks>`_ `#openstack-sdks <http://webchat.freenode.net?channels=%23openstack-sdks>`_
channel on Freenode. channel on Freenode.
Email Email
----- *****
The `openstack-dev <mailto:openstack-dev@openstack.org?subject=[python-openstacksdk]%20Question%20about%20the%20python-openstacksdk>`_ The `openstack-dev <mailto:openstack-dev@openstack.org?subject=[python-openstacksdk]%20Question%20about%20the%20python-openstacksdk>`_
mailing list fields questions of all types on OpenStack. Using the mailing list fields questions of all types on OpenStack. Using the

View File

@@ -1,10 +1,10 @@
.. include:: ../../README.rst .. include:: ../../README.rst
Contents Welcome!
======== ========
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
installation installation
usage usage