Makefile: Adds a target to build docs from the root dir.

waltznetworks · Oct 9, 2017 · b2959a9 · b2959a9
1 parent 26796f6
commit b2959a9
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -126,8 +126,7 @@ These are the basic steps needed to start developing on Sphinx.
 
    * Build the documentation and check the output for different builders::
 
-       cd doc
-       make clean html latexpdf
+       make docs target="clean html latexpdf"
 
    * Run code style checks and type checks (type checks require mypy)::
 

diff --git a/Makefile b/Makefile
@@ -114,3 +114,10 @@ covertest:
 .PHONY: build
 build:
 	@$(PYTHON) setup.py build
+
+.PHONY: docs
+docs:
+ifndef target
+	  $(info You need to give a provide a target variable, e.g. `make docs target=html`.)
+endif
+	  $(MAKE) -C doc $(target)