summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2013-09-04 21:38:02 +0200
committerKali Kaneko <kali@leap.se>2013-09-04 23:39:19 +0200
commit1fd9b7cffaf1063c3a2a23e056556be18ef3848a (patch)
treecd5c4a2a0494a2d887327f0fcc1d7de67b6a0f23
parent1782f6328de41a19dfa8e81f30b9fe31c1a0d34c (diff)
Update intro
-rw-r--r--docs/Makefile1
-rw-r--r--docs/conf.py15
-rw-r--r--docs/index.rst16
-rw-r--r--docs/user/intro.rst18
-rw-r--r--pkg/requirements-docs.pip1
5 files changed, 36 insertions, 15 deletions
diff --git a/docs/Makefile b/docs/Makefile
index 16aa258b..5c2c4145 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -4,6 +4,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
+#SPHINXBUILD = $(VIRTUAL_ENV)/bin/sphinx-build
PAPER =
BUILDDIR = _build
diff --git a/docs/conf.py b/docs/conf.py
index 082b4d67..3c908b2c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
-# LEAP documentation build configuration file, created by
+# Bitmask documentation build configuration file, created by
# sphinx-quickstart on Sun Jul 22 18:32:05 2012.
#
# This file is execfile()d with the current directory set to its containing dir.
@@ -25,10 +25,13 @@ sys.path.insert(0, os.path.abspath('../src/leap/bitmask/services'))
sys.path.insert(0, os.path.abspath('../src/leap/bitmask/services/eip'))
sys.path.insert(0, os.path.abspath('../src/leap/bitmask/util'))
-sys.path.insert(0, os.path.abspath(
- os.path.expanduser(
- '~/Virtualenvs/leap-client/local/lib/python2.7/'
- 'site-packages/leap/common')))
+try:
+ sys.path.insert(0, os.path.abspath(
+ os.path.expanduser(
+ '~/Virtualenvs/leap-bitmask/local/lib/python2.7/'
+ 'site-packages/leap/common')))
+except:
+ pass
# TODO: should add all the virtualenv site-packages to the path
# as a workaround, install all in your path.
@@ -130,7 +133,7 @@ html_theme = 'default'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
-html_logo = "../data/images/leap-color-small.png"
+html_logo = "../data/images/mask-small.png"
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
diff --git a/docs/index.rst b/docs/index.rst
index e3078929..d0b0ff22 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,15 +1,20 @@
-.. LEAP documentation master file, created by
+.. 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.
-LEAP Client
+Bitmask
=====================================
-Release v\ |version|. (`Impatient? jump to the` :ref:`Installation <install>` `section!`)
+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.
+**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
----------
@@ -48,7 +53,6 @@ If you want to contribute to the project, we wrote this for you.
.. dev/internals
dev/authors
dev/todo
- dev/workflow
Packager Guide
---------------
@@ -87,3 +91,5 @@ If you are looking for a reference to specific classes or functions, you are lik
:maxdepth: 2
api/leap
+
+
diff --git a/docs/user/intro.rst b/docs/user/intro.rst
index 22ad9356..b93df12b 100644
--- a/docs/user/intro.rst
+++ b/docs/user/intro.rst
@@ -6,26 +6,34 @@ Introduction
Bitmask
-------
.. if yoy change this, change it also in the index.rst
-**Bitmask** 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.
+**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.
Features
^^^^^^^^
Bitmask allows to easily secure communications.
-- Provider selection
-- User registration
+- Provider selection.
+- User registration.
- Encrypted Internet Proxy support (autoconfigured service using openvpn).
+- Encrypted email.
Coming soon
^^^^^^^^^^^^
-- Encrypted email
+- Encrypted chat.
+
.. _leapplatform:
The LEAP Platform
^^^^^^^^^^^^^^^^^
+
+.. image:: leap-color-small.*
+
The LEAP Provider Platform is the server-side part of LEAP that is run by service providers. It consists of a set of complementary packages and recipes to automate the maintenance of LEAP services in a hardened GNU/Linux environment. Our goal is to make it painless for service providers and ISPs to deploy a secure communications platform.
Read `more about the LEAP Platform <https://leap.se/en/technology/platform>`_ or `check out the code <https://github.com/leapcode/leap_platform>`_.
@@ -97,5 +105,7 @@ Bitmask is released under the terms of the `GNU GPL version 3`_ or later.
.. _`GNU GPL version 3`: http://www.gnu.org/licenses/gpl.txt
+.. _`PySide`: http://qt-project.org/wiki/PySide
+
.. ??? include whole version?
.. include:: ../COPYING
diff --git a/pkg/requirements-docs.pip b/pkg/requirements-docs.pip
new file mode 100644
index 00000000..6966869c
--- /dev/null
+++ b/pkg/requirements-docs.pip
@@ -0,0 +1 @@
+sphinx