Relintai
/
godot-docs
mirror of https://github.com/Relintai/godot-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #268 from solfen/solfen-add_windows_build_to_README 

Add building on windows section to README
This commit is contained in:
Rémi Verschelde 2016-10-16 12:57:51 +02:00 committed by GitHub
parent 0906f65d08 d51ca576ac
commit e796b7e247
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -55,6 +55,18 @@ make 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.
### Building with Sphinx on Windows
On Windows, you need to:
* Download the python installer [here](https://www.python.org/downloads/).
* Install python. Don't forget to check the "Add python to PATH" box.
* Use the above pip commands.
Building is still done at the root folder of this repository, but with this command line instead:
```sh
sphinx-build -b html ./ _build
```
### Building with Sphinx and virtualenv
If you want your Sphinx installation scoped to the project, you can install it using virtualenv.