-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Build documentation on TravisCI #1908
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
Conversation
I think we've talked about doing this a number of times in the past. It seems that we've been running into a number of uncaught build failures (e.g. #1898, #1881). This is one way of testing that the documentation build will pass on read the docs. If someone has a better of idea of how to do this, I'm all ears. |
This is really good idea, thanks! |
The build is failing with an error message about upgrading ruby?!? |
Well isn't that nice. CI is a two edged sword! I'll take a look. |
It looks like the doc build fails when it hits a warning:
We should either fix these warnings or stop them from failing the build :) |
It's really hard to get rid of all of them - I'd rather try option B ;) |
Currently we have 106 warnings at doc build on my system |
I had the fail-on-warning option turned on. I agree we should drop that for now. After we merge this, I'll open an issue to track cleaning those up at some point. I don't have time to fix them right now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @jhamman , this is very useful
whats-new.rst
for all changes andapi.rst
for new API (remove if this change should not be visible to users, e.g., if it is an internal clean-up, or if this is part of a larger project that will be documented later)