From 4b531179b0a19a45902f40f49e823cf5260bbd56 Mon Sep 17 00:00:00 2001 From: Athos Ribeiro Date: Thu, 27 Oct 2016 10:49:01 -0200 Subject: [PATCH 1/3] Add missing imports for documentation builds As mentioned in #3075, the build requirements for the project documentation were only listed in the Jenkins job. This commit adds those missing requirements to the project. Note that they should also be removed from the Jenkins build * fixes #3075 --- lib/galaxy/dependencies/pinned-requirements.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/galaxy/dependencies/pinned-requirements.txt b/lib/galaxy/dependencies/pinned-requirements.txt index 3f79978d5f7..173a3b40acd 100644 --- a/lib/galaxy/dependencies/pinned-requirements.txt +++ b/lib/galaxy/dependencies/pinned-requirements.txt @@ -69,3 +69,9 @@ ecdsa==0.13 # Flexible BAM index naming pysam==0.8.4+gx5 +# Documentation requirements +sphinx +sphinx_rtd_theme +lxml +recommonmark + From 647b4901c30d356f13f851a76c2a7c7ed8bfd808 Mon Sep 17 00:00:00 2001 From: Martin Cech Date: Wed, 26 Apr 2017 14:19:04 -0400 Subject: [PATCH 2/3] move reqs to dev-requirements and touch makefile --- Makefile | 4 ++-- lib/galaxy/dependencies/dev-requirements.txt | 6 ++++++ lib/galaxy/dependencies/pinned-requirements.txt | 6 ------ 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Makefile b/Makefile index 0c1f104516f..b272846b8e0 100644 --- a/Makefile +++ b/Makefile @@ -20,9 +20,9 @@ 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." -docs: ## generate Sphinx HTML documentation, including API docs +docs: ## generate HTML documentation, you must install documentation dependencies from lib/galaxy/dependencies/dev-requirements.txt beforehand $(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 6e3a6df309b..5cca8653334 100644 --- a/lib/galaxy/dependencies/dev-requirements.txt +++ b/lib/galaxy/dependencies/dev-requirements.txt @@ -2,3 +2,9 @@ nose NoseHTML twill==0.9.1 mock + +# Documentation requirements +sphinx +sphinx_rtd_theme +lxml +recommonmark diff --git a/lib/galaxy/dependencies/pinned-requirements.txt b/lib/galaxy/dependencies/pinned-requirements.txt index 173a3b40acd..3f79978d5f7 100644 --- a/lib/galaxy/dependencies/pinned-requirements.txt +++ b/lib/galaxy/dependencies/pinned-requirements.txt @@ -69,9 +69,3 @@ ecdsa==0.13 # Flexible BAM index naming pysam==0.8.4+gx5 -# Documentation requirements -sphinx -sphinx_rtd_theme -lxml -recommonmark - From 7edfe39f20024f161a30be14406c0baa2a9807bf Mon Sep 17 00:00:00 2001 From: Martin Cech Date: Wed, 26 Apr 2017 15:10:04 -0400 Subject: [PATCH 3/3] fix makefile help for docs thanks nsoranzo --- Makefile | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Makefile b/Makefile index e3ebd5ecabf..fce211714a8 100644 --- a/Makefile +++ b/Makefile @@ -24,8 +24,7 @@ SLIDESHOW_TO_PDF?=bash -c 'docker run --rm -v `pwd`:/cwd astefanutti/decktape /c all: help @echo "This makefile is used for building Galaxy's JS client, documentation, and drive the release process. A sensible all target is not implemented." -docs: -# Generate HTML documentation. +docs: ## Generate HTML documentation. # Run following commands to setup the Python portion of the requirements: # $ ./scripts/common_startup.sh # $ . .venv/bin/activate