Skip to content
Snippets Groups Projects
Commit 21037b02 authored by Vincent Texier's avatar Vincent Texier
Browse files

[enh] #101 WIP : update README documentation paragraph

parent 3e8cedac
No related branches found
No related tags found
2 merge requests!94Merge dev into master for release 0.56.0,!80Doc on gitlab pages
Pipeline #6408 skipped
Stage: release
Stage: publish_doc
Show whitespace changes
Inline Side-by-side
Showing
with 8 additions and 6 deletions
README.rst
+ 8
− 6
View file @ 21037b02
...@@ -40,9 +40,14 @@ You can install duniter-python-api and all its dependencies via the following pi ...@@ -40,9 +40,14 @@ You can install duniter-python-api and all its dependencies via the following pi
Documentation 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:: * Install Sphinx::
...@@ -52,10 +57,7 @@ But you can also generate and read the autodoc: ...@@ -52,10 +57,7 @@ But you can also generate and read the autodoc:
make docs make docs
* HTML Documentation is generated in docs/_build/html folder. * 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.
Development Development
----------- -----------
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment