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

2025-02-25 18:55:22 -06:00 · 2017-10-04 20:31:50 +02:00 · 2017-10-04 20:31:50 +02:00 · b2959a91c5
commit b2959a91c5
parent 26796f6985
2 changed files with 8 additions and 2 deletions
--- 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)::

--- a/7
+++ b/7
@ -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)