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

DOC: Use nbsphinx #1003

Merged
merged 1 commit into from Feb 22, 2021
Merged

DOC: Use nbsphinx #1003

merged 1 commit into from Feb 22, 2021

Conversation

mgeier
Copy link
Contributor

@mgeier mgeier commented Dec 30, 2019

This has been attempted before: #679.

Describe your changes

Switch from jupyter_sphinx to nbsphinx.

Change usage.rst to usage.ipynb.

Testing performed

Built the docs, looks good.

@mgeier
Copy link
Contributor Author

mgeier commented Jan 16, 2020

I've signed off, please review.

@SylvainCorlay
Copy link
Member

That looks good to me. I am fine with using nbsphinx instead of jupyter_sphinx - although both don't quite do the same thing generally.

@SylvainCorlay
Copy link
Member

@mgeier does nbsphinx run the notebook to generate the widget metadata or should we do this?

@mgeier
Copy link
Contributor Author

mgeier commented Jan 17, 2020

By default, and if there are no outputs stored in the notebook (as is the case in this PR), nbsphinx executes the notebook (with the help of nbconvert), which generates the widget data.

But you should probably not take my word for it, you should test it for yourself.

You might even want to add this to your CI (here's an example setup: https://github.com/spatialaudio/nbsphinx/blob/master/.circleci/config.yml).

Signed-off-by: Matthias Geier <Matthias.Geier@gmail.com>
@mgeier
Copy link
Contributor Author

mgeier commented Aug 5, 2020

Any news on this?

I've just re-based this PR for your merging convenience.

@JohanMabille
Copy link
Member

LGTM. ping @SylvainCorlay

@maartenbreddels
Copy link
Member

LGTM as wel!

@maartenbreddels maartenbreddels merged commit dbef3fd into bqplot:master Feb 22, 2021
@mgeier mgeier deleted the use-nbsphinx branch February 22, 2021 13:41
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.

None yet

4 participants