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

Document how to use Jupytext as a python library #316

Closed
choldgraf opened this issue Aug 22, 2019 · 1 comment · Fixed by #317
Closed

Document how to use Jupytext as a python library #316

choldgraf opened this issue Aug 22, 2019 · 1 comment · Fixed by #317

Comments

@choldgraf
Copy link
Contributor

I'd like to build in support for Jupytext files within Jupyter Book (so content can be stored in a jupytext-compliant format and would be converted to a notebook at build time). However, I don't see any obvious documentation to use Jupytext as a Python library in the docs. Maybe I'm missing something? But if not, it would be useful to know how to use Jupytext from within Python.

@mwouts
Copy link
Owner

mwouts commented Aug 22, 2019

Hello @choldgraf. Well I like very much what you suggest - it would also be a great illustration for for #247 (and we could start with Elegant Scipy, a book that is already written in the markdown format).

In short, my expectation for using Jupytext as a Python library is that you should be able to replace nbformat.read with jupytext.read.

There is a short section on this at https://jupytext.readthedocs.io/en/latest/using-cli.html#reading-notebooks-in-python. But you're right, we should at least move that paragraph to a section of its own, and why not, expand it.

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 a pull request may close this issue.

2 participants