Enhance notebook HTML conversion with selective cell hiding #17
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
nbconvertcommand in the GitHub Actions workflow to incorporateTagRemovePreprocessor.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
This update affects only the HTML conversion process; the original .ipynb files remain unaltered.