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

Enhance Notebook HTML Conversion with Selective Cell Hiding #15

Closed

Conversation

haticekaratay
Copy link

Summary

This PR updates our notebook-to-HTML conversion process to selectively hide cells, primarily focusing on markdown cells containing developer notes. By leveraging the "hide-cell" tag, we gain the flexibility to exclude any cell from the HTML output.

Changes

Modified the nbconvert command in the GitHub Actions workflow to incorporate TagRemovePreprocessor.
Introduced the ability to use the "hide-cell" tag for selectively hiding cells in the HTML output.

The main goal is to hide markdown cells with developer notes, which are not intended for the final audience.
While the primary use is for developer notes, this feature provides the flexibility to hide any cell in a notebook, including code or output cells, by using the "hide-cell" tag.

Tag markdown cells containing developer notes, or any other cells you wish to hide, with "hide-cell" in Jupyter notebooks.
This tagging will ensure these cells are excluded from the HTML conversion, making the published content cleaner and more focused.
Testing and Implementation
image

This update affects only the HTML conversion process; the original .ipynb files remain unaltered.

@haticekaratay
Copy link
Author

I created the PR but was unable to select the reviewers. Tagging instead, @BGannon2 , @mgough-970, @dulude

@camipacifici
Copy link

I am very excited to see this happening!! Thank you @haticekaratay !!
Tagging @eteq because he was also a sponsor for this work.

@mgough-970
Copy link
Collaborator

Closing PR - needs to be based off of v3 and pushed to v3

@mgough-970 mgough-970 closed this Dec 15, 2023
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 this pull request may close these issues.

3 participants