godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

update Sphinx build instructions

Browse Source
This commit is contained in:
Todd Ross
2018-01-10 13:54:47 -06:00
parent da9a710450
commit bd6d57392f
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@@ -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
README.md
View File

@@ -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.