diff --git a/Makefile b/Makefile index df165a0a520..fce211714a8 100644 --- a/Makefile +++ b/Makefile @@ -22,14 +22,14 @@ OPEN_RESOURCE=bash -c 'open $$0 || xdg-open $$0' SLIDESHOW_TO_PDF?=bash -c 'docker run --rm -v `pwd`:/cwd astefanutti/decktape /cwd/$$0 /cwd/`dirname $$0`/`basename -s .html $$0`.pdf' all: help - @echo "This makefile is primarily used for building Galaxy's JS client. A sensible all target is not yet implemented." + @echo "This makefile is used for building Galaxy's JS client, documentation, and drive the release process. A sensible all target is not 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: +docs: ## Generate HTML documentation. +# Run following commands to setup the Python portion of the requirements: # $ ./scripts/common_startup.sh # $ . .venv/bin/activate -# $ pip install sphinx sphinx_rtd_theme lxml recommonmark -docs: ## generate Sphinx HTML documentation, including API docs +# $ pip install -r lib/galaxy/dependencies/dev-requirements.txt +# You also need to install pandoc separately. $(IN_VENV) $(MAKE) -C doc clean $(IN_VENV) $(MAKE) -C doc html diff --git a/lib/galaxy/dependencies/dev-requirements.txt b/lib/galaxy/dependencies/dev-requirements.txt index 4900ba4eb4c..363a14792d6 100644 --- a/lib/galaxy/dependencies/dev-requirements.txt +++ b/lib/galaxy/dependencies/dev-requirements.txt @@ -3,3 +3,9 @@ NoseHTML twill==0.9.1 mock selenium + +# Documentation requirements +sphinx +sphinx_rtd_theme +lxml +recommonmark