Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
DuniterPy
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
clients
python
DuniterPy
Commits
21037b02
Commit
21037b02
authored
5 years ago
by
Vincent Texier
Browse files
Options
Downloads
Patches
Plain Diff
[enh]
#101
WIP : update README documentation paragraph
parent
3e8cedac
No related branches found
No related tags found
2 merge requests
!94
Merge dev into master for release 0.56.0
,
!80
Doc on gitlab pages
Pipeline
#6408
skipped
Stage: release
Stage: publish_doc
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.rst
+8
-6
8 additions, 6 deletions
README.rst
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
Documentation
-------------
`Examples <
https://
git
.duniter.o
rg/clients
/python/duniterpy/
tree/master/examples>`_ folder is full of scripts to help you!
Online official autodoc documentation:
https://
clients
.duniter.
i
o/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
-----------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment