Some quality-of-life enhancements to toc.py CLI script#329
Open
edoardob90 wants to merge 13 commits intomainfrom
Open
Some quality-of-life enhancements to toc.py CLI script#329edoardob90 wants to merge 13 commits intomainfrom
edoardob90 wants to merge 13 commits intomainfrom
Conversation
Add proper error handling, logging, command-line options, and improved documentation. Clean anchor generation, add version, and enhance CLI help text with better descriptions and examples.
edoardob90
added
documentation
Replace f-strings with %-style formatting in logger calls for better performance. Use logger.exception() for better error reporting with tracebacks.
Contributor
|
There is also: #131. Should that one be closed? |
Member
Author
Done, closed. We can track all the relevant changes here. |
Upgrade TocEntry from namedtuple to NamedTuple with type hints. Improve logic for detecting and ignoring markdown headers inside code blocks to prevent incorrect TOC entries. Also refactor the file output handling for better organization when using --force.
- Add PEP 723 inline script metadata so the script runs standalone via `uv run toc.py` without any manual dependency installation - Replace argparse with Typer: grouped help panels (Output / TOC Options / Misc), path validation delegated to Typer/Click, eager --version callback - Replace logging with Rich: console for stdout, stderr console for warnings, print_exception() for errors - Add APP_HELP embedded documentation covering how the tool works, the placeholder cell requirement, all output modes, and usage examples - build_toc() now returns a 3-tuple (notebook, toc_replaced, has_headings) so all I/O stays in main(); remove try/except from extract_toc() - Add toc_fixture.ipynb test fixture covering: fenced code blocks with # comments, multiple consecutive code blocks, language-spec fences, anchor generation edge cases, non-heading # patterns, and deep nesting - Bump version to 0.2.0
Jupyter only generates working anchor IDs for headings when each heading is in its own markdown cell. This adds --split-cells / -s which rewrites multi-heading cells into one cell per heading before TOC generation, so every link in the table of contents works correctly. New functions: - split_cell(): splits a single cell source at each heading boundary, respecting fenced code blocks and skipping the TOC header line - split_multi_heading_cells(): applies split_cell() across all markdown cells in a notebook, returning the modified notebook and a count of cells that were split build_toc() gains a split_cells parameter and returns a 4-tuple that includes the split count. main() passes the new --split-cells flag through and prints a summary line when cells were split. Also adds a dedicated multi-heading cell to toc_fixture.ipynb to exercise the splitting path, and bumps the version to 0.3.0.
Anchor format fix: JupyterLab sets data-jupyter-id on headings by replacing spaces with hyphens and preserving everything else verbatim. The previous implementation lowercased text and stripped all non-word characters, producing anchors that never matched. Fix: strip backticks only (they are markdown syntax, absent from rendered text) and replace spaces with hyphens, preserving case and all other characters. CLI improvements: - --output and --force are now mutually exclusive; passing both exits with a clear error message - --output paths missing the .ipynb extension have it appended automatically
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
2 participants
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.
Hopefully closes #240.
Add proper error handling, logging, command-line options, and improved documentation. Clean anchor generation, add version, and enhance CLI help text.