summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorTomas Touceda <chiiph@leap.se>2013-05-07 16:08:55 -0300
committerTomas Touceda <chiiph@leap.se>2013-05-07 16:08:55 -0300
commit4cc3c7d3f0d63d97df0d40c3e2d0941c5e069eb9 (patch)
treedfabf2a91cd8466b572539b73d38273eef733339 /docs/index.rst
parent76641e028f4a8b6c5c89ad0e9ff4bfecc075d678 (diff)
parente6b7d52d827109d6fc8d79a28e8d46964e1ad94c (diff)
Merge remote-tracking branch 'kali/feature/update-docs' into develop
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst89
1 files changed, 89 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..e3078929
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,89 @@
+.. 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 PySide, 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/workflow
+ 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.
+
+.. I should investigate a bit more how to skip some things, and how to give nice format
+ to the docstrings.
+ Maybe we should not have sphinx-apidocs building everything, but a minimal index of our own.
+
+.. toctree::
+ :maxdepth: 2
+
+ api/leap