From 70944f82b06ea929b89387f87553d0f3018d835f Mon Sep 17 00:00:00 2001 From: arve0 Date: Mon, 1 Dec 2014 16:26:07 +0100 Subject: [PATCH] fix building of doc in virtualenv. add short description in readme --- doc/Makefile | 2 +- doc/README.md | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 doc/README.md diff --git a/doc/Makefile b/doc/Makefile index befa2087..093f65ea 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -4,7 +4,7 @@ # You can set these variables from the command line. PYTHON ?= python SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build +SPHINXBUILD ?= python $(shell which sphinx-build) PAPER ?= # Internal variables. diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000..48e26788 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,5 @@ +# Building docs # +To build docs, run `make` in this directory. `make help` lists all targets. + +## Requirements ## +Sphinx is needed to build doc. Install with `pip install sphinx`.