From bd6d57392fbb59c3a7f6e803e42d5e355d7c1b5e Mon Sep 17 00:00:00 2001 From: Todd Ross Date: Wed, 10 Jan 2018 13:54:47 -0600 Subject: [PATCH] update Sphinx build instructions --- Makefile | 2 +- README.md | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 6d0da3d17..6fc4c2b25 100644 --- a/Makefile +++ b/Makefile @@ -10,7 +10,7 @@ LATEXDEPS = latex dvipng # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) endif # check for latex dependencies diff --git a/README.md b/README.md index c4fdbf2d6..754c038e5 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,12 @@ You can then build the HTML documentation from the root folder of this repositor make html ``` +or: + +```sh +make SPHINXBUILD=~/.local/bin/sphinx-build html +``` + The compilation might take some time as the `classes/` folder contains many files to parse. You can then test the changes live by opening `_build/html/index.html` in your favourite browser.