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

Update README: Add info about make.bat, MinGW

This commit is contained in:
Max Hilbrunner 2018-01-26 15:00:53 +01:00 committed by GitHub
parent 17d334e047
commit 7498882455
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -69,11 +69,21 @@ On Windows, you need to:
* 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:
Building is still done at the root folder of this repository using the provided `make.bat`:
```sh
make.bat html
```
Alternatively, you can build with this command instead:
```sh
sphinx-build -b html ./ _build
```
Note that during the first build, various installation prompts may appear and ask to install LaTeX plugins.
Make sure you don't miss them, especially if they open behind other windows, else the build may appear to hang until you confirm these prompts.
You could also install a normal `make` toolchain (for example via MinGW) and build the docs using the normal `make html`.
### Building with Sphinx and virtualenv
If you want your Sphinx installation scoped to the project, you can install it using virtualenv.