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

Fix api break #872

Merged
merged 4 commits into from
Sep 1, 2018
Merged

Fix api break #872

merged 4 commits into from
Sep 1, 2018

Conversation

mpacer
Copy link
Member

@mpacer mpacer commented Aug 31, 2018

Our documentation hasn't built since #814 was merged.

This is because it broke our check_version API which is used by nbsphinx to convert notebooks to sphinx compatible documentation.

This updates that to maintain backwards compatibility (by making it an optional argument) while maintaining the new functionality.

This also adds a test for the expected functionality so we don't break APIs again.

Also this updates the docs on how to build docs and release (and makes it easier to get the doc-building dependencies with a new extra requirements flag in setup.py).

@mpacer
Copy link
Member Author

mpacer commented Aug 31, 2018

@MSeal we should merge this before releasing.

Copy link
Contributor

@MSeal MSeal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Assuming tests pass :)

@MSeal MSeal merged commit caf130e into jupyter:master Sep 1, 2018
@MSeal MSeal mentioned this pull request Sep 1, 2018
@mpacer mpacer added this to the 5.4 milestone Sep 4, 2018
@ivanov
Copy link
Member

ivanov commented Sep 4, 2018

sorry about introducing a breaking change @mpacer - PyCon sprints were a bit of a blur, I had git greped to ensure that function wasn't being used anywhere else in the code base, but I was wrong to not consider others using this API. Thank you for fixing and adding tests so this doesn't happen again.

@t-makaro t-makaro mentioned this pull request Sep 23, 2018
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.

3 participants