From ae8e97d252151e36d0edbc595966bac108f622f9 Mon Sep 17 00:00:00 2001 From: Sam Morley-Short Date: Tue, 11 Jul 2017 14:07:23 +0100 Subject: [PATCH] Added instructions on how to compile docs for OSX --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 245cfee..25044e3 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ Python port of Anders and Briegel' s [method](https://arxiv.org/abs/quant-ph/050 ## Documentation You can read the full documentation [here](https://peteshadbolt.co.uk/abp/). You can also build it locally using Sphinx with `make doc`. +To install Sphinx on OSX, use `pip install sphinx`. If after doing so `make doc` still does not work, some OSX users may also need to install `sphinxcontrib-napoleon` by running `pip install sphinxcontrib-napoleon`. + ## Installation It's easiest to install with `pip`: