diff options
author | kali <kali@leap.se> | 2013-05-03 02:59:22 +0900 |
---|---|---|
committer | kali <kali@leap.se> | 2013-05-11 21:59:58 +0900 |
commit | 2dae2703fb8c2ae7e721ce83020c0dd10ff9ca33 (patch) | |
tree | 280cb8751c56d43769fb15ead4fb4476960ae06c /docs/pkg | |
parent | c85894efdbd6f65eb2b0c2edfc216827c192c1d1 (diff) |
updated documentation
* documentation reviewed after rewrite, ready for 0.2.1
* updated docstrings format to fit sphinx autodoc
Diffstat (limited to 'docs/pkg')
-rw-r--r-- | docs/pkg/debian.rst | 28 | ||||
-rw-r--r-- | docs/pkg/osx.rst | 7 | ||||
-rw-r--r-- | docs/pkg/win.rst | 7 |
3 files changed, 42 insertions, 0 deletions
diff --git a/docs/pkg/debian.rst b/docs/pkg/debian.rst new file mode 100644 index 00000000..e98032a5 --- /dev/null +++ b/docs/pkg/debian.rst @@ -0,0 +1,28 @@ +.. _debian: + +Debian +====== + +This section documents all related to the debian package. + + +Dependencies +------------ + +* ``openvpn`` +* ``python-qt4`` +* ``python-crypto`` +* ``python setuptools`` +* ``python-requests`` +* ``python-openssl`` + +.. note:: + these need a version that is not found in the current debian stable or in ubuntu 12.04. + They will be packaged... soon. + +* ``python-keyring`` + +For tests +^^^^^^^^^ +* ``python-nose``, ``python-mock``, ``python-coverage`` + diff --git a/docs/pkg/osx.rst b/docs/pkg/osx.rst new file mode 100644 index 00000000..dca018b6 --- /dev/null +++ b/docs/pkg/osx.rst @@ -0,0 +1,7 @@ +.. _osx: + +OS X +===== + +Nothing here +move on diff --git a/docs/pkg/win.rst b/docs/pkg/win.rst new file mode 100644 index 00000000..ef2cec5f --- /dev/null +++ b/docs/pkg/win.rst @@ -0,0 +1,7 @@ +.. _win: + +Windows +======= + +Nothing here +move on |