diff options
| author | Wouter Bolsterlee <uws@xs4all.nl> | 2013-05-21 21:48:53 +0200 |
|---|---|---|
| committer | Wouter Bolsterlee <uws@xs4all.nl> | 2013-05-21 21:51:36 +0200 |
| commit | 68ad8d28a6118c4a892f2c15e42813aa29b658ee (patch) | |
| tree | a759294c46363dde0b264db40f50923ebcf47439 /doc | |
| parent | e2874b2e2563426c982145260e1a44e70eee1c1a (diff) | |
| download | happybase-68ad8d28a6118c4a892f2c15e42813aa29b658ee.tar.gz | |
Restructure the documentation a bit
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api.rst | 6 | ||||
| -rw-r--r-- | doc/index.rst | 16 | ||||
| -rw-r--r-- | doc/installation.rst | 6 | ||||
| -rw-r--r-- | doc/user.rst (renamed from doc/tutorial.rst) | 8 |
4 files changed, 22 insertions, 14 deletions
diff --git a/doc/api.rst b/doc/api.rst index bce1437..c661d3c 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -1,6 +1,6 @@ -***************** -API documentation -***************** +============= +API reference +============= .. py:currentmodule:: happybase diff --git a/doc/index.rst b/doc/index.rst index 4d50cd1..c179199 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -52,15 +52,23 @@ The example below illustrates basic usage of the library. The :doc:`tutorial row = table.delete('row-key') -Contents of this documentation -============================== +Core documentation +================== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 installation - tutorial + user api + + +Additional documentation +======================== + +.. toctree:: + :maxdepth: 1 + news development todo diff --git a/doc/installation.rst b/doc/installation.rst index af3d986..7c0446a 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -1,6 +1,6 @@ -************ -Installation -************ +================== +Installation guide +================== .. highlight:: sh diff --git a/doc/tutorial.rst b/doc/user.rst index 52f142a..1685180 100644 --- a/doc/tutorial.rst +++ b/doc/user.rst @@ -1,6 +1,6 @@ -******** -Tutorial -******** +========== +User guide +========== .. py:currentmodule:: happybase @@ -17,7 +17,7 @@ documentation <api>`. :local: -Opening a connection +Managing connections ==================== We'll get started by connecting to HBase. Just create a new |