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

issue #56 Update generating sphinx html documentation

parent e0733485
No related branches found
No related tags found
No related merge requests found
...@@ -35,3 +35,7 @@ nosetests.xml ...@@ -35,3 +35,7 @@ nosetests.xml
.project .project
.pydevproject .pydevproject
.idea .idea
.python-version
docs/_build
docs/duniterpy.*
...@@ -39,6 +39,10 @@ Development ...@@ -39,6 +39,10 @@ Development
curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash` curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash`
* Install dependencies::
pip install -r requirements.txt
* Add PYTHONPATH env var to your shell containing the path to this repository * Add PYTHONPATH env var to your shell containing the path to this repository
* Run unit tests with:: * Run unit tests with::
...@@ -52,7 +56,11 @@ Development ...@@ -52,7 +56,11 @@ Development
Documentation Documentation
------------- -------------
* `HTML Documentation <https://git.duniter.org/clients/python/duniterpy/tree/master/docs/_build/html>`_ * Install Sphinx::
pip install -r requirements_dev.txt
* HTML Documentation is generated in docs/_build/html folder.
* `Examples <https://git.duniter.org/clients/python/duniterpy/tree/master/examples>`_ * `Examples <https://git.duniter.org/clients/python/duniterpy/tree/master/examples>`_
Packaging and deploy Packaging and deploy
...@@ -61,8 +69,6 @@ Packaging and deploy ...@@ -61,8 +69,6 @@ Packaging and deploy
Pypi Pypi
++++ ++++
*The README file must be in RestructuredText format (README.rst) for the long description field of the package.*
In the development pyenv environment, install the following tools:: In the development pyenv environment, install the following tools::
pip install --upgrade pip setuptools wheel pip install --upgrade pip setuptools wheel
......
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
import logging import logging
from . import network, blockchain, tx, wot, node, ud, ws from . import network, blockchain, tx, wot, node, ud, ws
__all__ = [network, blockchain, tx, wot, node, ud, ws] __all__ = ['network', 'blockchain', 'tx', 'wot', 'node', 'ud', 'ws']
PROTOCOL_VERSION = 2 PROTOCOL_VERSION = 2
......
sphinx
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment