Skip to content

Creates internal hyperlinks to make navigating large notebooks quicker.

License

Notifications You must be signed in to change notification settings

TomPiona/nb_toc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

nb_toc (Notebook Table of Contents)

Creates internal hyperlinks to make navigating large notebooks quicker.

$ pip install nb_toc

Usage

from nb_toc import generate
generate('my_notebook.ipynb')

It is possible to run this in a notebook while it is open, but make sure to save beforehand. Possible to use as a pre-commit hook.

Optional Parameters for generate

Argument Default Value Role
title 'Table of Contents' Header for TOC cell
additional_text None Text at end of TOC cell
indent_size 8 Amount of indentation for TOC
ignore_lower 0 Ignores headers <= this number
ignore_upper 7 Ignores headers >= this number

Example TOC

example

About

Creates internal hyperlinks to make navigating large notebooks quicker.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages