diff options
| author | drebs <drebs@leap.se> | 2012-12-24 10:14:58 -0200 |
|---|---|---|
| committer | drebs <drebs@leap.se> | 2012-12-24 10:14:58 -0200 |
| commit | 319e279b59ac080779d0a3375ae4d6582f5ee6a3 (patch) | |
| tree | 118dd0f495c0d54f2b2c66ea235e4e4e6b8cefd5 /docs/index.rst | |
| parent | ca5fb41a55e1292005ed186baf3710831d9ad678 (diff) | |
| parent | a7b091a0553e6120f3e0eb6d4e73a89732c589b2 (diff) | |
Merge branch 'develop' of ssh://code.leap.se/leap_client into develop
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..017fa32c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,87 @@ +.. LEAP documentation master file, created by + sphinx-quickstart on Sun Jul 22 18:32:05 2012. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +LEAP Client +===================================== + +Release v\ |version|. (`Impatient? jump to the` :ref:`Installation <install>` `section!`) + +.. if you change this paragraph, change it in user/intro too +The **LEAP Encryption Access Project Client** is a :ref:`GPL3 Licensed <gpl3>` multiplatform client, written in python using PyQt4, that supports the features offered by :ref:`the LEAP Platform <leapplatform>`. Currently is being tested on Linux, support for OSX and Windows will come soon. + +User Guide +---------- + +.. toctree:: + :maxdepth: 2 + + user/intro + user/install + user/running + +Tester Guide +------------ + +This part of the documentation details how to fetch the last development version and how to report bugs. + +.. toctree:: + :maxdepth: 1 + + testers/howto + +Hackers Guide +--------------- + +If you want to contribute to the project, we wrote this for you. + +.. toctree:: + :maxdepth: 1 + + dev/environment + dev/tests + dev/resources + dev/internationalization + +.. dev/internals + dev/authors + dev/todo + dev/workflow + +Packager Guide +--------------- + +Docs related to the process of building and releasing a version of the client. + +.. toctree:: + :maxdepth: 1 + + pkg/debian + pkg/osx + pkg/win + + +Directories and Files +--------------------- + +Different directories and files used for the configuration of the client. + +.. toctree:: + :maxdepth: 1 + + config/files + + +API Documentation +----------------- + +If you are looking for a reference to specific classes or functions, you are likely to find it here + +.. note:: + when it's finished, that's it :) + +.. toctree:: + :maxdepth: 2 + + api |