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

Documentation generation #7

Open
agoose77 opened this issue Apr 28, 2021 · 0 comments
Open

Documentation generation #7

agoose77 opened this issue Apr 28, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@agoose77
Copy link
Owner

Documentation should be generated directly from the notebooks using an HTML TemplateExporter. The input and output prompts should be also hidden. Users might want to customise the template, which can already be done by setting c.TemplateExporter.XXX options on the command-line, but we might want to think more carefully about this.

Additionally, we might want to use the export tag to indicate what is code vs what is usage, so that we can hide the source and link to it directly. See nbdev for an example of this. Personally, I think source should be the Jupyter Notebook, but if users feel strongly it might be worth configuring this so that it optionally goes to the generated source. I imagine this would take the form of a base_url option and an extension.

@agoose77 agoose77 added documentation Improvements or additions to documentation enhancement New feature or request labels May 17, 2021
@agoose77 agoose77 changed the title Feature: documentation generation Documentation generation May 17, 2021
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

No branches or pull requests

1 participant