From 1872e3532a0a46b6dfbcb96c98d6f792d8370746 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Bergstr=C3=B6m?= <david-bergstrom@outlook.com>
Date: Tue, 14 Aug 2018 08:35:00 +0200
Subject: [PATCH] Add instructions on building the documentation

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index 95453c5de..15a73c618 100644
--- a/README.md
+++ b/README.md
@@ -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
-- 
GitLab