From 21037b024905bcdde3e0495d6a392c81bd8e2e4b Mon Sep 17 00:00:00 2001 From: vtexier <vit@free.fr> Date: Sun, 11 Aug 2019 12:39:44 +0200 Subject: [PATCH] [enh] #101 WIP : update README documentation paragraph --- README.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 808e41dc..a25ecee5 100644 --- a/README.rst +++ b/README.rst @@ -40,9 +40,14 @@ You can install duniter-python-api and all its dependencies via the following pi Documentation ------------- -`Examples <https://git.duniter.org/clients/python/duniterpy/tree/master/examples>`_ folder is full of scripts to help you! +Online official autodoc documentation: https://clients.duniter.io/python/duniterpy/index.html -But you can also generate and read the autodoc: +`Examples folder <https://git.duniter.org/clients/python/duniterpy/tree/master/examples>`_ is full of scripts to help you! + +Please take a look at the document `HTTP API <https://git.duniter.org/nodes/typescript/duniter/blob/master/doc/HTTP_API.md>`_ +to learn more about the BMA API. + +How to generate and read locally the autodoc: * Install Sphinx:: @@ -52,10 +57,7 @@ But you can also generate and read the autodoc: make docs -* HTML Documentation is generated in docs/_build/html folder. - -Please take a look at the document `HTTP API <https://git.duniter.org/nodes/typescript/duniter/blob/master/doc/HTTP_API.md>`_ -to learn more about the BMA API. +* HTML Documentation is generated in `docs/_build/html` folder. Development ----------- -- GitLab