changes docs to single page

2017-02-05 18:56:19 -03:00
parent e33d4c0172
commit daafb2c5ac
5 changed files with 9 additions and 12 deletions
--- a/wrapper/python/wolfssl/Makefile
+++ b/wrapper/python/wolfssl/Makefile
@ -58,7 +58,7 @@ test : clean-pyc
 	tox

 docs :
-	$(MAKE) -C docs html
+	$(MAKE) -C docs singlehtml

 # publishes module at pypi
 upload : test
--- a/wrapper/python/wolfssl/README.rst
+++ b/wrapper/python/wolfssl/README.rst
@ -6,12 +6,12 @@ resource-constrained environments primarily because of its small size, speed,
 and portability.

 Installation
------------
+============

 In order to use ``wolfssl Python``, you'll also need to install ``wolfssl C``.

 Mac OSX
-~~~~~~~
+-------

 Installing from ``homebrew`` and ``pip`` package managers:

@ -41,7 +41,7 @@ Installing from ``source code``:


 Linux
-~~~~~
+-----

 .. code-block:: shell

@ -65,7 +65,7 @@ Linux


 Testing
-------
+=======

 To run the tox tests in the source code, you'll need ``tox`` and a few other
 requirements. The source code relies at **WOLFSSL_DIR/wrapper/python/wolfssl**
--- a/wrapper/python/wolfssl/docs/index.rst
+++ b/wrapper/python/wolfssl/docs/index.rst
@ -1,13 +1,8 @@
-.. include:: ../README.rst
-
-Summary
-=======
-
 .. toctree::
    :maxdepth: 2

+    installation
    usage
    api
    examples
-
-.. include:: ../LICENSING.rst
+    licensing
--- a/wrapper/python/wolfssl/docs/installation.rst
+++ b/wrapper/python/wolfssl/docs/installation.rst
@ -0,0 +1 @@
+.. include:: ../README.rst
--- a/wrapper/python/wolfssl/docs/licensing.rst
+++ b/wrapper/python/wolfssl/docs/licensing.rst
@ -0,0 +1 @@
+.. include:: ../LICENSING.rst