Skip to content
Snippets Groups Projects
Commit 1872e353 authored by David Bergström's avatar David Bergström
Browse files

Add instructions on building the documentation

parent 1230668d
No related branches found
No related tags found
No related merge requests found
......@@ -99,6 +99,21 @@ Studio.
See [separate page](pycharm.md).
# Building the documentation
1. Build the library binary as described above, the documentation uses the
binary to automate some parts
2. Install [Sphinx](http://www.sphinx-doc.org)
3. Go to the `docs` subfolder,
4. If you are **not** running Visual Studio and building in Release mode you
have to change row 17 of [conf.py](docs/conf.py) to match the location
of the resulting `pyd` file
5. Build the documentation:
* If you are using Windows, open a terminal, navigate to the docs/ folder
and run the command `make.bat html`.
* If you are using Linux, open a terminal, navigate to the docs/ folder and
run the command `make html`
# Credits
CommandCenter is written by [David Churchill](http://www.cs.mun.ca/~dchurchill/), Assistant Professor of [Computer Science](https://www.cs.mun.ca/) at Memorial University, and organizer of the [AIIDE StarCraft AI
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment