diff options
| author | Prashanth Pai <ppai@redhat.com> | 2016-06-09 15:19:57 +0530 |
|---|---|---|
| committer | Prashanth Pai <ppai@redhat.com> | 2016-06-09 16:33:13 +0530 |
| commit | f7f2dafb1e3d09017de6968a2a553d3e8b6c765c (patch) | |
| tree | dc46d31d639a321100724ca83d66862333892085 /doc/api-reference.rst | |
| parent | 972c24f8b11d5a3e7e6fc341453d9733b2bb47b5 (diff) | |
Revamp and complete API documentation
Created .rst files that sphinx can use to auto-generate entire
API documentation from doc strings present in code. This can be easily
rendered and hosted on ReadTheDocs website.
Change-Id: If1a569bdeaaba21919ac77ba8bd4967dfec22603
Signed-off-by: Prashanth Pai <ppai@redhat.com>
Diffstat (limited to 'doc/api-reference.rst')
| -rw-r--r-- | doc/api-reference.rst | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/api-reference.rst b/doc/api-reference.rst new file mode 100644 index 0000000..98b0427 --- /dev/null +++ b/doc/api-reference.rst @@ -0,0 +1,22 @@ +API Reference +============= + +Volume Class +------------ + +.. autoclass:: gluster.gfapi.Volume + :members: + :undoc-members: + :noindex: + + .. automethod:: gluster.gfapi.Volume.__init__ + +File Class +---------- + +.. autoclass:: gluster.gfapi.File + :members: + :undoc-members: + :noindex: + + .. automethod:: gluster.gfapi.File.__init__ |