From 5c0eb246d468454de9e84dca0d08c813459a5a6d Mon Sep 17 00:00:00 2001 From: kali Date: Wed, 19 Dec 2012 07:45:02 +0900 Subject: documentation update! reSTructured (no pun intended) the sphinx docs, and trimmed README --- docs/index.rst | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 docs/index.rst (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..5ccc6609 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,86 @@ +.. 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 Encryption Access Project Client +===================================== + +Release v\ |version|. (`Impatient? jump to the` :ref:`Installation ` `section!`) + +The **LEAP Client** is a :ref:`GPL3 Licensed ` multiplatform client, written in python using PyQt4, that supports the features offered by :ref:`the LEAP Platform `. 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 -- cgit v1.2.3 From 41a084823ebc967fcabb613a97e8d72c662dbe18 Mon Sep 17 00:00:00 2001 From: kali Date: Wed, 19 Dec 2012 09:38:42 +0900 Subject: added transifex config, updated some docs --- docs/index.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 5ccc6609..017fa32c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,12 +3,13 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -LEAP Encryption Access Project Client +LEAP Client ===================================== Release v\ |version|. (`Impatient? jump to the` :ref:`Installation ` `section!`) -The **LEAP Client** is a :ref:`GPL3 Licensed ` multiplatform client, written in python using PyQt4, that supports the features offered by :ref:`the LEAP Platform `. Currently is being tested on Linux, support for OSX and Windows will come soon. +.. if you change this paragraph, change it in user/intro too +The **LEAP Encryption Access Project Client** is a :ref:`GPL3 Licensed ` multiplatform client, written in python using PyQt4, that supports the features offered by :ref:`the LEAP Platform `. Currently is being tested on Linux, support for OSX and Windows will come soon. User Guide ---------- -- cgit v1.2.3 From ea4a3b3396caeeaa2be4dc46aecf386a56a522c9 Mon Sep 17 00:00:00 2001 From: kali Date: Fri, 21 Dec 2012 08:11:18 +0900 Subject: included api docs --- docs/index.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 017fa32c..a57e030f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -78,10 +78,14 @@ 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. + .. note:: - when it's finished, that's it :) + when it's a bit more polished, that's it :) .. toctree:: :maxdepth: 2 - api + api/leap -- cgit v1.2.3 From 51a99d6405bff732a37ad561b75cacfc13f2173d Mon Sep 17 00:00:00 2001 From: kali Date: Fri, 25 Jan 2013 18:13:55 +0900 Subject: updated docs about dev workflow --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index a57e030f..3e1a603f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -41,6 +41,7 @@ If you want to contribute to the project, we wrote this for you. dev/environment dev/tests + dev/workflow dev/resources dev/internationalization -- cgit v1.2.3