From daafb2c5ac6e8037206cd77c4836f97d9339ad8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moise=CC=81s=20Guimara=CC=83es?= Date: Sun, 5 Feb 2017 18:56:19 -0300 Subject: [PATCH] changes docs to single page --- wrapper/python/wolfssl/Makefile | 2 +- wrapper/python/wolfssl/README.rst | 8 ++++---- wrapper/python/wolfssl/docs/index.rst | 9 ++------- wrapper/python/wolfssl/docs/installation.rst | 1 + wrapper/python/wolfssl/docs/licensing.rst | 1 + 5 files changed, 9 insertions(+), 12 deletions(-) create mode 100644 wrapper/python/wolfssl/docs/installation.rst create mode 100644 wrapper/python/wolfssl/docs/licensing.rst diff --git a/wrapper/python/wolfssl/Makefile b/wrapper/python/wolfssl/Makefile index ec5288e50..1576ca662 100644 --- 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 diff --git a/wrapper/python/wolfssl/README.rst b/wrapper/python/wolfssl/README.rst index f55ee06bb..1a8e7250a 100644 --- 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** diff --git a/wrapper/python/wolfssl/docs/index.rst b/wrapper/python/wolfssl/docs/index.rst index 41df3bca8..344919f7f 100644 --- 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 diff --git a/wrapper/python/wolfssl/docs/installation.rst b/wrapper/python/wolfssl/docs/installation.rst new file mode 100644 index 000000000..72a335581 --- /dev/null +++ b/wrapper/python/wolfssl/docs/installation.rst @@ -0,0 +1 @@ +.. include:: ../README.rst diff --git a/wrapper/python/wolfssl/docs/licensing.rst b/wrapper/python/wolfssl/docs/licensing.rst new file mode 100644 index 000000000..f5cc633bb --- /dev/null +++ b/wrapper/python/wolfssl/docs/licensing.rst @@ -0,0 +1 @@ +.. include:: ../LICENSING.rst