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 documentation build to tools/test_pr.py #2201

Closed
bfroehle opened this issue Jul 25, 2012 · 7 comments
Closed

Add documentation build to tools/test_pr.py #2201

bfroehle opened this issue Jul 25, 2012 · 7 comments
Milestone

Comments

@bfroehle
Copy link
Contributor

It'd be pretty neat if we could also build the IPython documentation as part of tools/test_pr.py, as this would avoid issues like #2200.

Actually building the docs is pretty simple. The IPython debian package builds them by running:

PYTHONPATH=`pwd` make -C docs html

This only needs to happen for one version of Python, and only if Sphinx (and other requisite packages) are installed.

@minrk
Copy link
Member

minrk commented Jul 25, 2012

There are actually quite a lot of environments where the docs don't build, or at least there used to be.

@minrk
Copy link
Member

minrk commented Jul 25, 2012

Wait, I think I'm thinking of the PDF docs, which are quite finicky - the HTML docs are easy, nevermind.

@takluyver
Copy link
Member

This should be an optional extra, though, because it slows down the PR testing even more (I actually want to speed it up, see #2026). And as an optional extra, it wouldn't get used very often.

Perhaps a better approach to this is to set up a ShiningPanda job that builds the docs. That should be quite easy, I'll have a go at it now.

@takluyver
Copy link
Member

Starting its first build: https://jenkins.shiningpanda.com/ipython/job/ipython-docs/

@takluyver
Copy link
Member

After a bit of fiddling, I've successfully replicated the error from #2200. When we commit the fix, hopefully the build will pass again.

@fperez
Copy link
Member

fperez commented Jul 26, 2012

I agree with @takluyver, test_pr if anything is already too slow. I prefer the CI approach in this case. @bfroehle, if you agree we can close this one and go with CI instead.

@bfroehle
Copy link
Contributor Author

You bet.

@minrk minrk added this to the no action milestone Mar 26, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants