Skip to content

Commit 10e7734

Browse files
committed
Documentation Formatting
1 parent 9db3d8d commit 10e7734

3 files changed

Lines changed: 37 additions & 25 deletions

File tree

docs/api/managers.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.. _managers:
2+
3+
Managers
4+
--------
5+
::
6+
7+
>>> from SoftLayer.CCI import CCIManager
8+
>>> cci = CCIManager(client)
9+
>>> cci.list_instances()
10+
[...]
11+
12+
Managers mask out a lot of the complexities of using the API into classes that provide a simpler interface to various services.
13+
14+
.. toctree::
15+
:maxdepth: 1
16+
:glob:
17+
18+
managers/*

docs/index.rst

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
.. SoftLayer API Python Client documentation
22
3-
SoftLayer API Python Client
4-
===========================
3+
SoftLayer API Python Client |version|
4+
========================================
55
This is the documentation to SoftLayer's Python API Bindings. These bindings use SoftLayer's `XML-RPC interface <http://sldn.softlayer.com/article/XML-RPC>`_ in order to manage SoftLayer services.
66

7-
Release v\ |version|. (:ref:`Installation <install>`)
7+
.. toctree::
8+
:maxdepth: 2
9+
10+
install
11+
SoftLayer API Documentation <http://sldn.softlayer.com/reference/softlayerapi>
12+
Source on Github <https://github.com/softlayer/softlayer-api-python-client>
13+
SoftLayer Developer Network <http://sldn.softlayer.com/>
14+
Twitter <https://twitter.com/SoftLayerDevs>
15+
816

917
API Documentation
1018
-----------------
@@ -19,26 +27,8 @@ API Documentation
1927
.. toctree::
2028
:maxdepth: 2
2129

22-
install
2330
api/client
24-
25-
26-
Managers
27-
--------
28-
::
29-
30-
>>> from SoftLayer.CCI import CCIManager
31-
>>> cci = CCIManager(client)
32-
>>> cci.list_instances()
33-
[...]
34-
35-
Managers mask out a lot of the complexities of using the API into classes that provide a simpler interface to various services.
36-
37-
.. toctree::
38-
:maxdepth: 1
39-
:glob:
40-
41-
api/managers/*
31+
api/managers
4232

4333

4434
Command-Line Interface
@@ -58,6 +48,7 @@ Command-Line Interface
5848
cli
5949
cli/dev
6050

51+
6152
Indices and tables
6253
==================
6354

docs/install.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Installation
44
============
5+
6+
Using Pip
7+
---------
8+
59
Install via pip: ::
610

711
$ pip install softlayer
@@ -13,9 +17,8 @@ Install from source gia pip (requires git): ::
1317
The most up to date version of this library can be found on the SoftLayer GitHub public repositories: http://github.com/softlayer. Please post to the SoftLayer forums http://forums.softlayer.com/ or open a support ticket in the SoftLayer customer portal if you have any questions regarding use of this library.
1418

1519

16-
17-
Get the Code
18-
------------
20+
From Source
21+
-----------
1922

2023
The project is developed on GitHub, at `github.com/softlayer/softlayer-api-python-client <https://github.com/softlayer/softlayer-api-python-client>`_.
2124

0 commit comments

Comments
 (0)