Browse code
minor corrections to the documentation
Joseph Weston authored on 09/09/2017 21:35:53
Showing 3 changed files
| ... | ... |
@@ -1,6 +1,21 @@ |
| 1 | 1 |
Nord: an unofficial NordVPN client |
| 2 | 2 |
================================== |
| 3 | 3 |
|
| 4 |
+.. badges-start |
|
| 5 |
+ |
|
| 6 |
+.. image:: https://img.shields.io/badge/License-GPL%20v3-blue.svg |
|
| 7 |
+ :target: https://img.shields.io/badge/License-GPL%20v3-blue.svg |
|
| 8 |
+ :alt: GPLv3 License |
|
| 9 |
+ |
|
| 10 |
+.. image:: https://badge.fury.io/py/nord.svg |
|
| 11 |
+ :target: https://badge.fury.io/py/nord |
|
| 12 |
+ :alt: PyPi package |
|
| 13 |
+ |
|
| 14 |
+.. image:: https://readthedocs.org/projects/nord/badge/?version=stable |
|
| 15 |
+ :target: http://nord.readthedocs.io/en/stable/?badge=stable |
|
| 16 |
+ :alt: Documentation Status |
|
| 17 |
+ |
|
| 18 |
+.. badges-end |
|
| 4 | 19 |
.. doc-start |
| 5 | 20 |
|
| 6 | 21 |
Overview |
| ... | ... |
@@ -11,7 +26,7 @@ Overview |
| 11 | 26 |
Nord is a client for interacting with the `NordVPN`_ service. |
| 12 | 27 |
|
| 13 | 28 |
At its core is a high-level Python API for interacting both with the web service |
| 14 |
-provided by NordVPN, and for connecting to VPN servers using the OpenVPN client. |
|
| 29 |
+provided by NordVPN, and for connecting to VPN servers using OpenVPN. |
|
| 15 | 30 |
|
| 16 | 31 |
Nord also contains components that expose this API as a command line tool, |
| 17 | 32 |
and (soon) as a web service and frontend. |
| ... | ... |
@@ -54,9 +69,9 @@ pass_:: |
| 54 | 69 |
Prerequesites |
| 55 | 70 |
------------- |
| 56 | 71 |
- GNU/Linux system |
| 72 |
+- Python 3.6 |
|
| 57 | 73 |
- ``openvpn`` |
| 58 | 74 |
- ``sudo`` |
| 59 |
-- Python 3.6 |
|
| 60 | 75 |
|
| 61 | 76 |
nord contains many Linux-isms (e.g. using the ``sudo`` program to obtain root |
| 62 | 77 |
access) so it will certainly not work on Windows, it may possibly work |
| ... | ... |
@@ -125,3 +140,10 @@ Developing |
| 125 | 140 |
virtualenv -p python3.6 |
| 126 | 141 |
source venv/bin/activate |
| 127 | 142 |
pip install -e .[dev] |
| 143 |
+ |
|
| 144 |
+Building the API documentation |
|
| 145 |
+****************************** |
|
| 146 |
+:: |
|
| 147 |
+ |
|
| 148 |
+ make -C docs html |
|
| 149 |
+ xdg-open docs/build/html/index.html |
| ... | ... |
@@ -19,7 +19,9 @@ |
| 19 | 19 |
# |
| 20 | 20 |
import os |
| 21 | 21 |
import sys |
| 22 |
-sys.path.insert(0, os.path.abspath('..'))
|
|
| 22 |
+sys.path.insert(0, os.path.abspath('../..'))
|
|
| 23 |
+ |
|
| 24 |
+import nord |
|
| 23 | 25 |
|
| 24 | 26 |
|
| 25 | 27 |
# -- General configuration ------------------------------------------------ |
| ... | ... |
@@ -59,9 +61,9 @@ author = 'Joseph Weston' |
| 59 | 61 |
# built documents. |
| 60 | 62 |
# |
| 61 | 63 |
# The short X.Y version. |
| 62 |
-version = '' |
|
| 64 |
+version = nord.__version__ |
|
| 63 | 65 |
# The full version, including alpha/beta/rc tags. |
| 64 |
-release = '' |
|
| 66 |
+release = nord.__version__ |
|
| 65 | 67 |
|
| 66 | 68 |
# The language for content autogenerated by Sphinx. Refer to documentation |
| 67 | 69 |
# for a list of supported languages. |
| ... | ... |
@@ -1,5 +1,9 @@ |
| 1 |
-``nord``: an unofficial NordVPN client for GNU/Linux |
|
| 2 |
-==================================================== |
|
| 1 |
+Nord: an unofficial NordVPN client for GNU/Linux |
|
| 2 |
+================================================ |
|
| 3 |
+ |
|
| 4 |
+.. include:: ../../README.rst |
|
| 5 |
+ :start-after: badges-start |
|
| 6 |
+ :end-before: badges-end |
|
| 3 | 7 |
|
| 4 | 8 |
.. include:: ../../README.rst |
| 5 | 9 |
:start-after: overview |