Browse Source

Merge pull request #968 from brainsick/makefile-sphinx-fix

update Sphinx build instructions
Rémi Verschelde 7 years ago
parent
commit
06071b087e
2 changed files with 7 additions and 1 deletions
  1. 1 1
      Makefile
  2. 6 0
      README.md

+ 1 - 1
Makefile

@@ -10,7 +10,7 @@ LATEXDEPS     = latex dvipng
 
 
 # User-friendly check for sphinx-build
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
 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
 endif
 
 
 # check for latex dependencies
 # check for latex dependencies

+ 6 - 0
README.md

@@ -53,6 +53,12 @@ You can then build the HTML documentation from the root folder of this repositor
 make html
 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.  
 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.
 You can then test the changes live by opening `_build/html/index.html` in your favourite browser.