blob: d0b0ff221a942f67b50bba1372a69d30b074f6ff (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
.. 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 <install>` `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 <leapplatform>`.
It is written in python using `PySide`_ and :ref:`licensed under the GPL3 <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
|
