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

[EPIC] Use nbsphinx to integrate Jupyter notebooks with Sphinx documentation #76

Open
chmreid opened this issue Dec 12, 2019 · 0 comments
Assignees
Labels

Comments

@chmreid
Copy link
Collaborator

chmreid commented Dec 12, 2019

In order to address #75 (repository is missing quickstart instructions), the data-consumer-vignettes repo needs the Jyupyter notebooks to be readable and presentable automatically, without needing to manually populate a table of contents, readmes for each project, etc.

Toward this end, we propose using nbsphinx to automatically turn Jupyter notebooks into Sphinx documentation pages. This will help with making the vignette notebooks more consistent, and will make writing quickstart instructions a lot easier.

@chmreid chmreid added this to the Q4 2019 Milestone 3 milestone Dec 12, 2019
@chmreid chmreid self-assigned this Dec 12, 2019
@chmreid chmreid added the Epic label Dec 19, 2019
@chmreid chmreid changed the title Use nbsphinx to integrate Jupyter notebooks with Sphinx documentation [EPIC] Use nbsphinx to integrate Jupyter notebooks with Sphinx documentation Dec 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant