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 as a Python library #15

Closed
choldgraf opened this issue Feb 28, 2020 · 1 comment · Fixed by #35
Closed

Document how to use as a Python library #15

choldgraf opened this issue Feb 28, 2020 · 1 comment · Fixed by #35
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@choldgraf
Copy link
Member

Currently the README focuses on the CLI use-case for Jupyter-Cache. I think that we'll probably want to use the Python API when using it as a part of a build system. We should document this part of the user-facing API.

@choldgraf choldgraf added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 28, 2020
@mmcky
Copy link
Member

mmcky commented Mar 2, 2020

@choldgraf -- @chrisjsewell and I had a discussion on this topic yesterday. I will meet up with @aakash today to discuss ways we can link myst-parser and myst-nb to get the outputs added to notebooks. We will look at the python api rather than the cli -- but @chrisjsewell suggested looking at the CLI to understand how the python api is put together.

@chrisjsewell chrisjsewell linked a pull request Mar 12, 2020 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants