Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing imports for documentation builds #3104

Merged
merged 4 commits into from Apr 27, 2017

Conversation

@athos-ribeiro
Copy link
Contributor

commented Oct 27, 2016

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

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

@galaxybot galaxybot added the triage label Oct 27, 2016

@galaxybot galaxybot added this to the 16.10 milestone Oct 27, 2016

@jmchilton

This comment has been minimized.

Copy link
Member

commented Nov 14, 2016

Thanks for the fix! These aren't required runtime by Galaxy - so these should be placed into dev-requirements in that same directory instead. Unfortunately we build binary dependencies for all of our requirements so more work is needed before even that change can be merged. I created an issue for this here #3166.

I'm going to mark this as WIP until this issue is resolved and I opened a PR to at least document this implicit requirement (#3167). Thanks again!

@bgruening

This comment has been minimized.

Copy link
Member

commented Dec 3, 2016

@athos-ribeiro can you address @jmchilton comments? Would be nice to get this fixed :) Thanks!

@bgruening

This comment has been minimized.

Copy link
Member

commented Jan 8, 2017

@jmchilton jmchilton modified the milestones: 17.05, 17.01 Jan 12, 2017

@martenson martenson removed this from the 17.05 milestone Apr 26, 2017

@martenson martenson self-assigned this Apr 26, 2017

@martenson

This comment has been minimized.

Copy link
Member

commented Apr 26, 2017

This is now ready for review. @bgruening @jmchilton

(the wheels are not necessary for this)

@martenson martenson added this to the 17.05 milestone Apr 26, 2017

# $ ./scripts/common_startup.sh
# $ . .venv/bin/activate
# $ pip install sphinx sphinx_rtd_theme lxml recommonmark
docs: ## generate Sphinx HTML documentation, including API docs

This comment has been minimized.

Copy link
@nsoranzo

nsoranzo Apr 26, 2017

Member

This change will break the help target, which requires the syntax:

target: ## target help

This comment has been minimized.

Copy link
@martenson

martenson Apr 26, 2017

Member

Thanks! I think I fixed this below.

fix makefile help for docs
thanks nsoranzo
@nsoranzo

This comment has been minimized.

Copy link
Member

commented Apr 26, 2017

py27-unit and qunit builds are broken by the babel requirement from sphinx which probably is conflicting with our Babel 2.0 wheel.

@martenson

This comment has been minimized.

Copy link
Member

commented Apr 26, 2017

@nsoranzo should we move this to different requirement file that does not get installed during tests? :/

@jmchilton

This comment has been minimized.

Copy link
Member

commented Apr 27, 2017

@martenson We should update our babel I'd imagine. Let I'll open a PR that does that and see if the tests run fine?

@jmchilton

This comment has been minimized.

Copy link
Member

commented Apr 27, 2017

Oh wait - nevermind... sphinx wants an older babel :(...

Update 2: Actually it just needs to be not exactly 2.0 - I'll try 2.4.

Update 3: xref sphinx-doc/sphinx@6bce0a1

@nsoranzo

This comment has been minimized.

Copy link
Member

commented Apr 27, 2017

Updating Babel is a sensible idea, not sure if having a separate doc-requirements file is worthwhile.

@jmchilton

This comment has been minimized.

Copy link
Member

commented Apr 27, 2017

@martenson

This comment has been minimized.

Copy link
Member

commented Apr 27, 2017

thanks @jmchilton , I merged and restarted the build

@martenson martenson merged commit 7ba3662 into galaxyproject:dev Apr 27, 2017

5 checks passed

api test Build finished. 275 tests run, 0 skipped, 0 failed.
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
framework test Build finished. 148 tests run, 0 skipped, 0 failed.
Details
integration test Build finished. 34 tests run, 0 skipped, 0 failed.
Details
toolshed test Build finished. 579 tests run, 0 skipped, 0 failed.
Details
@martenson

This comment has been minimized.

Copy link
Member

commented Apr 27, 2017

yay! thanks @nsoranzo @jmchilton and @athos-ribeiro !

@jmchilton

This comment has been minimized.

Copy link
Member

commented Apr 27, 2017

Fantastic - thanks for awesome contribution @athos-ribeiro and sorry for the delay.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.