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

Sphinx documentation fixes and tests #352

Merged
merged 7 commits into from Nov 6, 2016

Conversation

Projects
None yet
2 participants
@doismellburning
Contributor

doismellburning commented Nov 5, 2016

  1. Fails builds with Sphinx/rST errors
  2. Fixes Sphinx/rST errors so the build passes!
@doismellburning

This comment has been minimized.

Show comment
Hide comment
@doismellburning

doismellburning Nov 5, 2016

Contributor

Because I got very confused when I read https://batavia.readthedocs.io/en/latest/tutorials/testing.html and saw:

Here is a simplified sample of what the Batavia .travis.yml file looks like:

The basic gist is...

(Because the yaml wasn't rendered due to build errors!)

Contributor

doismellburning commented Nov 5, 2016

Because I got very confused when I read https://batavia.readthedocs.io/en/latest/tutorials/testing.html and saw:

Here is a simplified sample of what the Batavia .travis.yml file looks like:

The basic gist is...

(Because the yaml wasn't rendered due to build errors!)

@doismellburning

This comment has been minimized.

Show comment
Hide comment
@doismellburning

doismellburning Nov 5, 2016

Contributor

Obviously I have a selfish interest here, but the sooner this is merged, the less likely future contributions are to break the build further!

Contributor

doismellburning commented Nov 5, 2016

Obviously I have a selfish interest here, but the sooner this is merged, the less likely future contributions are to break the build further!

doismellburning added a commit to doismellburning/sphinx that referenced this pull request Nov 5, 2016

Have generated Makefile set -W to ensure warnings are handled
Several build warnings aren't just minor trifles, they can result in
hefty gaps and omissions in generated documentation - see
pybee/batavia#352 for an example

Unfortunately this also includes some actual cosmetic things (like title
underline length) which is likely to increase friction, but I feel the
tradeoff should be worthwhile

doismellburning added a commit to doismellburning/sphinx that referenced this pull request Nov 5, 2016

Have generated Makefile set -W to ensure warnings are handled
Several build warnings aren't just minor trifles, they can result in
hefty gaps and omissions in generated documentation - see
pybee/batavia#352 for an example

Unfortunately this also includes some actual cosmetic things (like title
underline length) which is likely to increase friction, but I feel the
tradeoff should be worthwhile

As this is only a change to the generated Makefile, it won't negatively
affect existing projects, and it can easily be removed if found
objectionable.
@doismellburning

This comment has been minimized.

Show comment
Hide comment
@doismellburning

doismellburning Nov 5, 2016

Contributor

Obviously I have a selfish interest here, but the sooner this is merged, the less likely future contributions are to break the build further!

Scratch that, I hadn't seen #341 and #346 - I'll happily re-do my stuff on top of those if that helps!

Contributor

doismellburning commented Nov 5, 2016

Obviously I have a selfish interest here, but the sooner this is merged, the less likely future contributions are to break the build further!

Scratch that, I hadn't seen #341 and #346 - I'll happily re-do my stuff on top of those if that helps!

@freakboy3742

This looks great. In the slightly longer term, once we get pybee/beefore integration working, the documentation build check should be pulled out as a separate precheck - but in the meantime, this is a good stop-gap measure.

@freakboy3742 freakboy3742 merged commit ca2ba32 into pybee:master Nov 6, 2016

1 check passed

ci/circleci Your tests passed on CircleCI!
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment