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

issue #55 Update README with make docs command

Use Makefile for docs and tests
parent 970aa3a6
No related branches found
No related tags found
No related merge requests found
Makefile 0 → 100644
.PHONY: docs tests
# generate documentation
docs:
cd docs && sphinx-apidoc -o . ../duniterpy && make html && cd ..
# run tests
tests:
python -m unittest
...@@ -46,7 +46,7 @@ Development ...@@ -46,7 +46,7 @@ Development
* 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::
python -m unittest make tests
* Take a look at examples folder * Take a look at examples folder
* Run examples from parent folder:: * Run examples from parent folder::
...@@ -60,6 +60,10 @@ Documentation ...@@ -60,6 +60,10 @@ Documentation
pip install -r requirements_dev.txt pip install -r requirements_dev.txt
* Generate documentation::
make docs
* HTML Documentation is generated in docs/_build/html folder. * 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>`_
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment