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

Generate .ipynb for <example> sections in API reference docs #536

Open
dsyme opened this issue Jul 15, 2020 · 1 comment
Open

Generate .ipynb for <example> sections in API reference docs #536

dsyme opened this issue Jul 15, 2020 · 1 comment

Comments

@dsyme
Copy link
Contributor

dsyme commented Jul 15, 2020

Currently the fsdocs tool generates an .ipynb for every literate script of markdown file if a _template.ipynb is present (it can be an empty file).

We could also easily generate .ipynb for API reference docs. That is fsdocs could generate a notebook for each "" section from the XML docs, and optionally add a mybinder link for each example. Then all API docs would be easily made executable

@Fxplorer
Copy link
Contributor

include .dib

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

No branches or pull requests

2 participants