stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 18:29:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
update Sphinx build instructions
This commit is contained in:
Rémi Verschelde
2018-01-11 14:13:40 +01:00
committed by GitHub
parent f8c60fc6df bd6d57392f
commit 06071b087e
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Makefile
+1 -1
View File
@@ -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
README.md
+6
View File
@@ -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.