From 652879ef39b5a94fba50f8c78524e71e040e8b5b Mon Sep 17 00:00:00 2001 From: Kali Kaneko Date: Wed, 25 Sep 2013 12:28:21 -0400 Subject: update client docs This are the most important pages in the bitmask documentation. I have converted .rst files using pandoc, since the .rst does not seem to be supported like the README says. I have added @nav_title and @title headers. --- docs/client/client-index.rst | 95 -------------------------------------------- 1 file changed, 95 deletions(-) delete mode 100644 docs/client/client-index.rst (limited to 'docs/client/client-index.rst') diff --git a/docs/client/client-index.rst b/docs/client/client-index.rst deleted file mode 100644 index d0b0ff2..0000000 --- a/docs/client/client-index.rst +++ /dev/null @@ -1,95 +0,0 @@ -.. Bitmask 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. - -Bitmask -===================================== - -Release v \ |version|. (`Impatient? jump to the` :ref:`Installation ` `section!`) - -.. if you change this paragraph, change it in user/intro too -**Bitmask** is the multiplatform desktop client for the services offered by :ref:`the LEAP Platform `. -It is written in python using `PySide`_ and :ref:`licensed under the GPL3 `. -Currently we distribute pre-compiled bundles for Linux and OSX, with Windows -bundles following soon. - -.. _`PySide`: http://qt-project.org/wiki/PySide - -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 - -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 - - -- cgit v1.2.3