Skip to content

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

Merged
merged 12 commits into from
Feb 15, 2018
Merged

Build documentation on TravisCI #1908

merged 12 commits into from
Feb 15, 2018

Conversation

jhamman
Copy link
Member

@jhamman jhamman commented Feb 13, 2018

  • Closes zarr RTD docs broken #1898 (remove if there is no corresponding issue, which should only be the case for minor changes)
  • Tests added (for all bug fixes or enhancements)
  • Tests passed (for all non-documentation changes)
  • Fully documented, including whats-new.rst for all changes and api.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)

@jhamman
Copy link
Member Author

jhamman commented Feb 13, 2018

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.

@shoyer
Copy link
Member

shoyer commented Feb 13, 2018

This is really good idea, thanks!

@shoyer
Copy link
Member

shoyer commented Feb 13, 2018

The build is failing with an error message about upgrading ruby?!?

@jhamman
Copy link
Member Author

jhamman commented Feb 13, 2018

Well isn't that nice. CI is a two edged sword! I'll take a look.

@shoyer
Copy link
Member

shoyer commented Feb 15, 2018

It looks like the doc build fails when it hits a warning:

Warning, treated as error:
/home/travis/build/pydata/xarray/doc/api.rst:1: WARNING: Inline emphasis start-string without end-string.

We should either fix these warnings or stop them from failing the build :)

@fmaussion
Copy link
Member

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 ;)

@fmaussion
Copy link
Member

Currently we have 106 warnings at doc build on my system

@jhamman
Copy link
Member Author

jhamman commented Feb 15, 2018

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.

Copy link
Member

@fmaussion fmaussion left a 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

@jhamman jhamman merged commit 174fe5d into pydata:master Feb 15, 2018
@jhamman jhamman deleted the test/travis_docs branch February 15, 2018 23:20
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

Successfully merging this pull request may close these issues.

zarr RTD docs broken
3 participants