tobias/docker-offlineimap
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
09fca0ccb1
docker-offlineimap/docs/doc-src/index.rst

22 lines
483 B
ReStructuredText
Raw Normal View History

Add beginnings of sphinx-based code documentation The docs still need some meat, but the infrastructure is in place. THis allows us to generate the nice looking API documentation that many python projects already have. We should document our API better, providing an overview of the functionality available. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-04-27 10:37:15 +02:00
.. OfflineImap documentation master file
move some documentation to the website Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-10 03:54:12 +01:00
.. _OfflineIMAP: http://offlineimap.github.io
Add beginnings of sphinx-based code documentation The docs still need some meat, but the infrastructure is in place. THis allows us to generate the nice looking API documentation that many python projects already have. We should document our API better, providing an overview of the functionality available. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-04-27 10:37:15 +02:00
docs: full refactoring of the MANUAL Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-10 14:55:54 +01:00
Welcome to OfflineIMAP's developer documentation
================================================
Add beginnings of sphinx-based code documentation The docs still need some meat, but the infrastructure is in place. THis allows us to generate the nice looking API documentation that many python projects already have. We should document our API better, providing an overview of the functionality available. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-04-27 10:37:15 +02:00
Improve documentation Improve wording, and integrate the MANUAL and INSTALL and FAQ documents into our complete user manual that is hosted online. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-01-17 01:34:56 +01:00
**Developer documentation**
rework documentation - Add CONTRIBUTING.rst. - Improve MAINTAINERS.rst. - Split long HACKING.rst into: * dco.rst * GitAdvanced.rst Update content. Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-07 19:08:22 +01:00
* :doc:`Advanced Git <GitAdvanced>`
Add beginnings of sphinx-based code documentation The docs still need some meat, but the infrastructure is in place. THis allows us to generate the nice looking API documentation that many python projects already have. We should document our API better, providing an overview of the functionality available. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-04-27 10:37:15 +02:00
docs: full refactoring of the MANUAL Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-10 14:55:54 +01:00
**Documented APIs**
Add beginnings of sphinx-based code documentation The docs still need some meat, but the infrastructure is in place. THis allows us to generate the nice looking API documentation that many python projects already have. We should document our API better, providing an overview of the functionality available. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-04-27 10:37:15 +02:00
move some documentation to the website Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2015-03-10 03:54:12 +01:00
.. toctree::
Improve documentation Improve wording, and integrate the MANUAL and INSTALL and FAQ documents into our complete user manual that is hosted online. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-01-17 01:34:56 +01:00
API
repository
ui
Add beginnings of sphinx-based code documentation The docs still need some meat, but the infrastructure is in place. THis allows us to generate the nice looking API documentation that many python projects already have. We should document our API better, providing an overview of the functionality available. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-04-27 10:37:15 +02:00
Improve the developer API documentation Improve the code documentation (still much more to do) and also add some more meat to the structure of the developer documentation. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-05-02 17:11:40 +02:00
Improve documentation Improve wording, and integrate the MANUAL and INSTALL and FAQ documents into our complete user manual that is hosted online. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-01-17 01:34:56 +01:00
.. moduleauthor:: John Goerzen, and many others. See AUTHORS and the git history for a full list.
Add beginnings of sphinx-based code documentation The docs still need some meat, but the infrastructure is in place. THis allows us to generate the nice looking API documentation that many python projects already have. We should document our API better, providing an overview of the functionality available. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de> Signed-off-by: Nicolas Sebrecht <nicolas.s-dev@laposte.net>
2011-04-27 10:37:15 +02:00
Improve documentation Improve wording, and integrate the MANUAL and INSTALL and FAQ documents into our complete user manual that is hosted online. Signed-off-by: Sebastian Spaeth <Sebastian@SSpaeth.de>
2012-01-17 01:34:56 +01:00
:License: This module is covered under the GNU GPL v2 (or later).
Reference in New Issue Copy Permalink