From d51ca576ac60a8f1e7e0ab5e83899adf117486e1 Mon Sep 17 00:00:00 2001 From: maximelore Date: Sun, 16 Oct 2016 12:48:05 +0200 Subject: [PATCH] Add building on windows section to README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 07c30161..f28ce371 100644 --- a/README.md +++ b/README.md @@ -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.