From 6c4d430d75781dac112f0c7b56fe61208d081f1c Mon Sep 17 00:00:00 2001 From: John Chilton Date: Sun, 13 Nov 2016 23:16:13 -0500 Subject: [PATCH] Add note about building docs to Makefile. --- Makefile | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Makefile b/Makefile index d616ca38252..c7e6e5539c8 100644 --- a/Makefile +++ b/Makefile @@ -22,6 +22,11 @@ SLIDESHOW_TO_PDF?=bash -c 'docker run --rm -v `pwd`:/cwd astefanutti/decktape /c all: help @echo "This makefile is primarily used for building Galaxy's JS client. A sensible all target is not yet implemented." +# Building docs requires sphinx and utilities be installed (see issue 3166) as well as pandoc. +# Run following commands to setup the Python portion of these requirements: +# $ ./scripts/common_startup.sh +# $ . .venv/bin/activate +# $ pip install sphinx sphinx_rtd_theme lxml recommonmark docs: ## generate Sphinx HTML documentation, including API docs $(IN_VENV) $(MAKE) -C doc clean $(IN_VENV) $(MAKE) -C doc html