From 120e7baa2f9665228edd0633f1082a89da290836 Mon Sep 17 00:00:00 2001
From: Vincent Texier <vit@free.fr>
Date: Thu, 19 Jul 2018 19:16:48 +0200
Subject: [PATCH] issue #55 Update README with make docs command
Use Makefile for docs and tests
---
Makefile | 10 ++++++++++
README.rst | 6 +++++-
2 files changed, 15 insertions(+), 1 deletion(-)
create mode 100644 Makefile
diff --git a/Makefile b/Makefile
new file mode 100644
index 00000000..e14bc3e2
--- /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 d757a834..44bf9cb0 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>`_
--
GitLab