Skip to main content

A Python package for generating a table of contents for Jupyter notebooks

Project description

Jupyter Notebook ToC

This is a simple extension to generate a table of contents for a Jupyter notebook, like so:

from jupyter_toc import toc

print( toc.build("your_notebook.ipynb") )

It will return something like this, which you can copy to a markdown cell:

Table of Contents
- [Introduction](#introduction)
 - [Subhead](##subhead)
- [Usage](#usage)
- [Development](#development)

Development

  • Create a virtual env: python3 -m venv venv
  • Activate the virtual env: source venv/bin/activate
  • Install the dependencies: pip install -r requirements.txt
  • To run the test script: python3 -m unittest test_toc.py

Authors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter-toc-0.1.0.tar.gz (14.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page