From a4c812f8865f48dbd4a3816179cb4c52d1937a9a Mon Sep 17 00:00:00 2001 From: Derek Schaller Date: Sat, 13 Oct 2018 11:27:57 -0700 Subject: [PATCH] add root make target for creating html version of docs --- Makefile | 11 +++++++++++ README.md | 11 ++--------- 2 files changed, 13 insertions(+), 9 deletions(-) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..c1a00054 --- /dev/null +++ b/Makefile @@ -0,0 +1,11 @@ +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @grep -E '^\.PHONY: [a-zA-Z_-]+ .*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = "(: |##)"}; {printf "\033[36m%-30s\033[0m %s\n", $$2, $$3}' + +.PHONY: docs ## Generate docs +docs: + @cd docs &&\ + pip install -r requirements.txt &&\ + make html &&\ + cd - diff --git a/README.md b/README.md index 98193506..a5a64f09 100644 --- a/README.md +++ b/README.md @@ -112,15 +112,8 @@ Tox can only use whatever versions of python are installed on your system. When The documentation is generated using the excellent [Sphinx](http://www.sphinx-doc.org/) and a custom theme. -The documentation dependencies are installed by running: +An HTML version of the documentation is produced by running: ```sh -cd docs -pip install -r requirements.txt -``` - -Then to produce a HTML version of the documentation: - -```sh -make html +make docs ```