diff --git a/Makefile b/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..e14bc3e24478f6e9e14b5e15e02da37b6b0969be --- /dev/null +++ b/Makefile @@ -0,0 +1,10 @@ +.PHONY: docs tests + +# generate documentation +docs: + cd docs && sphinx-apidoc -o . ../duniterpy && make html && cd .. + +# run tests +tests: + python -m unittest + diff --git a/README.rst b/README.rst index d757a834168773e932d45db0d888fb2ab8b0347f..44bf9cb0408f092a2db3fcb0aef350039865d4ec 100644 --- a/README.rst +++ b/README.rst @@ -46,7 +46,7 @@ Development * Add PYTHONPATH env var to your shell containing the path to this repository * Run unit tests with:: - python -m unittest + make tests * Take a look at examples folder * Run examples from parent folder:: @@ -60,6 +60,10 @@ Documentation pip install -r requirements_dev.txt +* Generate documentation:: + + make docs + * HTML Documentation is generated in docs/_build/html folder. * `Examples <https://git.duniter.org/clients/python/duniterpy/tree/master/examples>`_