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

Have build machinery recognize and "hide" developer notes #3

Open
eteq opened this issue Mar 24, 2020 · 1 comment
Open

Have build machinery recognize and "hide" developer notes #3

eteq opened this issue Mar 24, 2020 · 1 comment

Comments

@eteq
Copy link
Collaborator

eteq commented Mar 24, 2020

We would like to be able to keep "developer notes" in the notebooks as they exist in source form, but strip them out in the rendered notebook. This requires a few things:

  1. Agreeing on exactly what constitutes a "developer note". The easiest rule I can see is for cell that begins with Development note/Developer note (case-insensitive?) to be treated such that the whole cell is a developer note.
  2. The build machinery, when run, should remove those cells before (or in the process of) executing. So the generated exec* notebooks should come with them removed. Then the html conversion will use that and come with the developer notes stripped out.
  3. To facilitate allowing users to download the version with the developer notes removed, we should add a link that allows the exec* to be downloaded by clicking on a download icon or something e.g. the download buttons from Astropy tutorials like http://learn.astropy.org/rst-tutorials/color-excess.html?highlight=filtertutorials
@camipacifici
Copy link
Contributor

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