diff options
| author | Patrick Totzke <patricktotzke@gmail.com> | 2011-11-28 11:46:34 +0000 |
|---|---|---|
| committer | Patrick Totzke <patricktotzke@gmail.com> | 2011-11-28 11:46:34 +0000 |
| commit | cdcaa7a5af6a523f6131f941d6448b47c2ef37cd (patch) | |
| tree | ec860839ec221d6f32390a116a35ff1b978aa2a8 /docs | |
| parent | 4f6e44d3a39549f125582c99f0d329168d12fca1 (diff) | |
restructured api docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/accounts.rst | 5 | ||||
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/db.rst | 26 | ||||
| -rw-r--r-- | docs/index.rst | 16 |
4 files changed, 10 insertions, 39 deletions
diff --git a/docs/accounts.rst b/docs/accounts.rst index abf2b25d..8bbb208a 100644 --- a/docs/accounts.rst +++ b/docs/accounts.rst @@ -1,6 +1,5 @@ - -Getting Account information -====================================== +Accounts +======== .. currentmodule:: alot.account diff --git a/docs/conf.py b/docs/conf.py index 321bd473..68474715 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -148,7 +148,7 @@ html_static_path = ['_static'] #html_split_index = False # If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True +html_show_sourcelink = False # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. #html_show_sphinx = True diff --git a/docs/db.rst b/docs/db.rst deleted file mode 100644 index 61908ee6..00000000 --- a/docs/db.rst +++ /dev/null @@ -1,26 +0,0 @@ -Database Abstraction -====================================== - -.. module:: alot.db - -:class:`DBManager` ---------------------------- -.. autoclass:: DBManager - :members: - -:class:`Thread` ---------------------------- -.. autoclass:: Thread - :members: - -.. module:: alot.message - -:class:`Message` ---------------------------- -.. autoclass:: Message - :members: - -:class:`Attachment` ---------------------------- -.. autoclass:: Attachment - :members: diff --git a/docs/index.rst b/docs/index.rst index f67b41fc..a629874c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,19 +1,17 @@ -.. alot documentation master file, created by - sphinx-quickstart on Tue Aug 9 15:00:51 2011. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to alot's API documentation! -==================================== +`alot` API overview +==================== Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - db + database + interface interaction + settings accounts + utils Indices and tables |