How to create a table of contents in a jupyter notebook ?
How to create a table of contents in a jupyter notebook ?
then, to create a table of contents, a solution is to create a markdown link to an anchor:
Add the anchors to the notebook
Then, just add the anchors
For example the TOC link
How to create a table of contents in a jupyter notebook ?
References
| Links | Site |
|---|---|
| How can I add a table of contents to a Jupyter / JupyterLab notebook? | stackoverflow |
| iPython (er, Jupyter) Table of Contents | medium.com |
| Table of Contents (2) | jupyter-contrib-nbextensions.readthedocs.io |
Author 
Benjamin
Greetings, I am Ben! I completed my PhD in Atmospheric Science from the University of Lille, France. Subsequently, for 12 years I was employed at NASA as a Research Scientist focusing on Earth remote sensing. Presently, I work with NOAA concentrating on satellite-based Active Fire detection. Python, Machine Learning and Open Science are special areas of interest to me.
Skills
- Remote sensing
- Python
- Machine Learning
- Tensorflow 2.0
report this ad
How to Add a Table of Contents to Your JupyterJupyterLab Notebook
In this tutorial, we’ll walk through the process of adding a table of contents (TOC) to your Jupyter and JupyterLab notebooks. This feature is incredibly useful for organizing and navigating complex notebooks with sections, subsections, and code snippets.
A table of contents can help data scientists and software engineers quickly find and access specific parts of a notebook, making it easier to understand and work with the content.
Table of Contents:
Why Use a Table of Contents?
A table of contents is an essential tool for structuring and navigating lengthy notebooks, especially for data science projects, which often involve multiple data cleaning, analysis, and visualization steps. With a TOC, you can:
- Easily navigate between sections and subsections of your notebook
- Improve the organization and readability of your work
- Share your notebook with colleagues, making it more accessible and easier to understand
Now that we understand the benefits of a TOC, let’s dive into the process of adding one to your Jupyter and JupyterLab notebooks.
Adding a TOC in Jupyter Notebook
To add a table of contents to a Jupyter Notebook, we’ll use the “toc2” extension, which is part of the “jupyter_contrib_nbextensions” package. Here’s how to install and enable it:
- Install the “jupyter_contrib_nbextensions” package using pip:
- Install the Javascript and CSS files for the extensions:
- Enable the “toc2” extension:
Now, when you open a Jupyter Notebook, you’ll see a new “Table of Contents” button in the toolbar. Clicking this button will display a TOC based on the Markdown headers in your notebook.
Note: If the “toc2” extension doesn’t show up in your notebook, try restarting the Jupyter Notebook server.
Adding a TOC in JupyterLab
In JupyterLab, adding a table of contents is even easier, thanks to the built-in TOC extension. Here’s how to enable it:
Open JupyterLab and click the “Extensions” button in the left sidebar (it looks like a puzzle piece).
Search for “table of contents” in the extensions search bar.
If the “Table of Contents” extension is not already installed, click the “Install” button. If it’s installed but not enabled, click the “Enable” button.
You should now see a “Table of Contents” tab in the left sidebar. Click this tab to display the TOC for the currently open notebook.
The TOC will automatically update as you add, remove, or edit Markdown headers in your notebook.
Customizing Your TOC
Both the toc2 extension for Jupyter Notebook and the built-in TOC extension for JupyterLab offer customization options, including:
- Collapsing/Expanding sections
- Displaying a TOC cell within the notebook (Jupyter Notebook only)
- Limiting the depth of the TOC
- Numbering sections and subsections
- Changing the appearance of the TOC
For the toc2 extension in Jupyter Notebook, you can customize these settings by clicking the “Table of Contents Settings” button in the toolbar (next to the TOC button).
In JupyterLab, you can access the settings for the TOC extension by clicking the gear icon in the “Table of Contents” tab of the left sidebar.
Conclusion
We’ve covered how to add a table of contents to both Jupyter Notebook and JupyterLab, as well as how to customize the appearance and behavior of your TOC. With a well-structured TOC in place, you and your colleagues can easily navigate and collaborate on complex data science projects, leading to more efficient and effective work.
Remember to share this tutorial with your fellow data scientists and software engineers to help them add TOCs to their Jupyter and JupyterLab notebooks!
Table Of Contents#
The table of contents makes it easy to see and navigate the structure of a document.
A table of contents is auto-generated in the left sidebar when you have a notebook, markdown, latex or python files opened. The entries are clickable, and scroll the document to the heading in question.
In the sidebar panel, you can number headings, collapse sections, and navigate into the file.
Here is an animation showing the table of content use with a notebook:
The table of contents will be automatically generated for your notebook by taking all the headings from your markdown cells. Each listed section will be linked to the actual section within your document.
Markdown headings with a HTML tag that contains the class jp-toc-ignore will be ignored; e.g. # Title <a class="jp-toc-ignore"></a> .
Automatic section numbering will go through your Notebook and number your sections and subsection as designated by your headings. This means that if you’ve moved one or more big sections around several times, you won’t have to go through your document and renumber it, as well as all its subsections, yourself.
Automatic section numbering can be skipped for first-level headings ( h1 ). You can toggle that option via the More actions button in the table of contents toolbar. Here is an animation showing its use:
Context menus are added to those table of contents headings having notebook sections containing runnable code cells, and clicking the Select and Run Cell(s) for this Heading option will make the cells run in notebook. Here is an animation showing its use:
Cell heading collapse state will be synchronized between the table of contents and notebook if the syncCollapseState attribute is set to true in the settings. If a heading is collapsed in the table of contents the notebook will also gets collapsed and similarly expanding cells in notebook will expand the table of contents. To activate that feature go to settings and click on Settings Editor and then go to Table of Contents section and in User Preferences check the syncCollapseState box. Here is an animation showing its use:
The headings in the cell outputs get numbered by default in the table of contents and the notebook. This can be tuned by changing the settings includeOutput to false . To perform that go to settings and click on Settings Editor and then go to Table of Contents section and in User Preferences add unchecked includeOutput box. Here is an animation showing its use
Settings#
The table of contents behavior can be modified via settings which can be set in JupyterLab’s settings editor.
includeOutput : Whether to list headings from the cell outputs or not.
maximalDepth : Maximal headings depth (default: 4).
numberingH1 : Whether to number the first-level headings ( h1 ) or not.
numberHeaders : Whether to number the headings or not.
syncCollapseState : Whether to synchronize the cell and the table of contents collapse state or not.
baseNumbering : Starting point for heading numbering (default: 1).
How to Add a Table of Contents in the Jupyter Notebook
It is essential to build a framework that is simple for the new readers to understand in order to avoid this situation. A table of contents is a very helpful approach to illustrate the procedure and can even aid in developing an initial strategy.
In this article, we will demonstrate how to create a table of contents using a Jupyter notebook.
How to Add a Table of Contents in a Jupyter Notebook
No matter how big or little the project is, adding a table of contents makes it clear with what path the project will take. The only tools required to include a table of contents in a Jupyter notebook are the “anchor tags” in the appropriate places. The links that point to the other sections of the notebook’s table of content are translated into such links.
Creating a table of content in a Jupyter notebook is quite easy and simple. You can complete it in the following number of steps:
Step 1: Select the Markdown Format
We can add the table of content in the Jupyter notebook using the HTML anchor. This is a simple two-step process. Open the Jupyter notebook and select the markdown cell format instead of the code.
Step 2: Create the Structure of the Table of Content
First, create a table of contents using the markdown in the notebook. Here, we also need to link the anchors that we will create in the next step. Use the following text and paste it into the markdown cell:
Press “Shift + Enter” to run the previous lines in the Jupyter notebook. The table of content should display like this:
The structure of the table of content follows the markdown format available in the Jupyter notebook. In the previous screenshot, the displayed name of the link is enclosed in brackets [] and the reference to the anchor tags is placed in parenthesis preceded by a hash (#) symbol.
The markdown cell in the anchor tag is included in either a title to go with the operation or a description of the current processes.
Step 3: Create Anchor Tags
Now, we will create the anchor tags in order to link with the table of contents. Create the chapters, sections, and subsections. Enter the following text in the next markdown cell:
Press “Shift + Enter” or run this cell to see the effects. The following output should display on your notebook:
Here, you will notice that you can easily navigate to the desired section from the table of content.
Conclusion
We demonstrated in this article how to create a table of content in a Jupyter notebook. Using a table of content, you can easily manage all the content and can easily navigate to the desired section of your document. We can also add a table of content in a Jupyter notebook using the pre-build extensions. I hope this article increases your understanding about the Jupyter notebook.
About the author
Samreena Aslam
Samreena Aslam holds a master’s degree in Software Engineering. Currently, she’s working as a Freelancer & Technical writer. She’s a Linux enthusiast and has written various articles on Computer programming, different Linux flavors including Ubuntu, Debian, CentOS, and Mint.
How to Add a Table of Contents in the Jupyter Notebook
It is essential to build a framework that is simple for the new readers to understand in order to avoid this situation. A table of contents is a very helpful approach to illustrate the procedure and can even aid in developing an initial strategy.
In this article, we will demonstrate how to create a table of contents using a Jupyter notebook.
How to Add a Table of Contents in a Jupyter Notebook
No matter how big or little the project is, adding a table of contents makes it clear with what path the project will take. The only tools required to include a table of contents in a Jupyter notebook are the “anchor tags” in the appropriate places. The links that point to the other sections of the notebook’s table of content are translated into such links.
Creating a table of content in a Jupyter notebook is quite easy and simple. You can complete it in the following number of steps:
Step 1: Select the Markdown Format
We can add the table of content in the Jupyter notebook using the HTML anchor. This is a simple two-step process. Open the Jupyter notebook and select the markdown cell format instead of the code.
Step 2: Create the Structure of the Table of Content
First, create a table of contents using the markdown in the notebook. Here, we also need to link the anchors that we will create in the next step. Use the following text and paste it into the markdown cell:
Press “Shift + Enter” to run the previous lines in the Jupyter notebook. The table of content should display like this:
The structure of the table of content follows the markdown format available in the Jupyter notebook. In the previous screenshot, the displayed name of the link is enclosed in brackets [] and the reference to the anchor tags is placed in parenthesis preceded by a hash (#) symbol.
The markdown cell in the anchor tag is included in either a title to go with the operation or a description of the current processes.
Step 3: Create Anchor Tags
Now, we will create the anchor tags in order to link with the table of contents. Create the chapters, sections, and subsections. Enter the following text in the next markdown cell:
Press “Shift + Enter” or run this cell to see the effects. The following output should display on your notebook:
Here, you will notice that you can easily navigate to the desired section from the table of content.
Conclusion
We demonstrated in this article how to create a table of content in a Jupyter notebook. Using a table of content, you can easily manage all the content and can easily navigate to the desired section of your document. We can also add a table of content in a Jupyter notebook using the pre-build extensions. I hope this article increases your understanding about the Jupyter notebook.
About the author
Samreena Aslam
Samreena Aslam holds a master’s degree in Software Engineering. Currently, she’s working as a Freelancer & Technical writer. She’s a Linux enthusiast and has written various articles on Computer programming, different Linux flavors including Ubuntu, Debian, CentOS, and Mint.
Configure the Table of Contents#
This page covers some of the options you have available to control your book’s behavior via the Table of Contents.
Configure all entries in the TOC#
To configure options for all entries of your TOC, use the defaults: configuration at the root of your Table of Contents. This configuration will be applied to every list of chapters or sections within your book.
Configure a single top-level set of chapters/sections#
If you’re only using a single list of chapters, and not organizing them into parts, you can configure the single group of chapters with the options: key.
If you’re using parts , then the options: key has no effect. You should configure each part individually (see below).
Configure one or more Parts#
If you are organizing your book into parts (groups of chapters), configure each part by providing key: value pairs alongside each part entry, like so:
In this case, the numbered: only applies to Part 1, and not Part 2. If you want all parts to be numbered, you will need to add numbered: true to all parts entries.
Currently there is no global setting to enable numbered: true across all parts.
as sphinx will issue warnings due to numbered flag being set for subtrees. It also causes unexpected output.
Add captions to Parts#
To add a caption to a Part (so that it shows up in the sidebar, for example) use the caption: option like so:
Specify alternate titles#
If you’d like to specify an alternate title from the one defined within a file, you may do so with the title: key. For example:
Note that this only applies to the sidebar in the table of contents, it does not change the actual chapter/section title.
Number your chapters and sections#
You can automatically add numbers chapters of your book. Numbers will follow a hierarchy according to the structure defined in your _toc.yml file.
Number a single group of chapters#
If using a single set of chapters for your book (aka, no Parts), add numbers to them with the numbered: true flag, like so:
Number one or more parts#
If using one or more parts, add the numbered: true option to each. For example, to number all parts in a two-part book:
To number only the second part of a book:
Restart numbering between parts#
By default, chapter numbering will be continuous between parts (i.e. they will not re-start each section at 1. each time) using an extension called sphinx-multitoc-numbering.
To restart chapter numbering between parts, use the following setting in your _config.yml file:
Limit the depth of numbering#
If you’d like to limit the depth of numbering, use an integer for the numbered flag. This will be the depth of sub-sections to continue numbering. For example, numbered: 3 .
A few caveats about numbering
Jupyter Book relies on Sphinx to apply section numbering, and this has a few quirks to it. Here are a few gotchas:
Numbering applies to sections of your page. Note that when you add numbering to a section, it will add numbers to each header in a file. This means that if you have headers in a top-level section, then its headers will become numbered as sub-sections, and any other files underneath it will begin as third-level children. See How headers and sections map onto to book structure for more information.
Numbering resets across parts. If you specify groups of sections via — part: entries, then numbering will restart between them. That means if you have two — part: entries with 2 pages each, you will have two sets of 1. and 2. sections, one for each part.
Add a table of contents to a page’s content#
If you’d like to add a table of contents for the sub-sections of a page within the page content (in-line with the content on the page), you may do so by using the
See the source of the content types page for an example.
Control the depth of the displayed Table of Contents#
To control the maximum depth of the Table of Contents that you insert, use the maxdepth: option in your _toc.yml file. For example:
Add a within-page Table of Contents#
A within-page Table of Contents shows the sections that are present on the current page (as opposed to the sub-pages listed in _toc.yml , as inserted by the
To insert a within-page Table of Contents, use the
By default, the
Add a section-specific list of contents#
To only list the section titles for sub-sections of a specific parent section, add the :local: argument to the
To list only the contents of the ## Section 1 section:
Limit the depth of the in-page contents#
You can control the depth of the within-page Table of Contents with the :maxdepth: argument. For example, the following usage lists only the top-level sections underneath the title, even if there are deeper sub-sections (i.e., ## headings, but no ### headings or deeper).
Exclude pages from your build#
By default, Jupyter Book will build all content files that are found in your book’s folder, even if they are not specified in _toc.yml (and will raise a warning if it finds a file that isn’t listed there).
If you’d like Jupyter Book to skip a file entirely, you can do so with the following configuration in _config.yml :
Any files that match the patterns described there will be excluded from the build. If you’d like to exclude files from being executed but still wish for them to be built by Jupyter Book, see Exclude files from execution .
How to Add a Table of Contents to Your JupyterJupyterLab Notebook
In this tutorial, we’ll walk through the process of adding a table of contents (TOC) to your Jupyter and JupyterLab notebooks. This feature is incredibly useful for organizing and navigating complex notebooks with sections, subsections, and code snippets.
A table of contents can help data scientists and software engineers quickly find and access specific parts of a notebook, making it easier to understand and work with the content.
Table of Contents:
Why Use a Table of Contents?
A table of contents is an essential tool for structuring and navigating lengthy notebooks, especially for data science projects, which often involve multiple data cleaning, analysis, and visualization steps. With a TOC, you can:
- Easily navigate between sections and subsections of your notebook
- Improve the organization and readability of your work
- Share your notebook with colleagues, making it more accessible and easier to understand
Now that we understand the benefits of a TOC, let’s dive into the process of adding one to your Jupyter and JupyterLab notebooks.
Adding a TOC in Jupyter Notebook
To add a table of contents to a Jupyter Notebook, we’ll use the “toc2” extension, which is part of the “jupyter_contrib_nbextensions” package. Here’s how to install and enable it:
- Install the “jupyter_contrib_nbextensions” package using pip:
- Install the Javascript and CSS files for the extensions:
- Enable the “toc2” extension:
Now, when you open a Jupyter Notebook, you’ll see a new “Table of Contents” button in the toolbar. Clicking this button will display a TOC based on the Markdown headers in your notebook.
Note: If the “toc2” extension doesn’t show up in your notebook, try restarting the Jupyter Notebook server.
Adding a TOC in JupyterLab
In JupyterLab, adding a table of contents is even easier, thanks to the built-in TOC extension. Here’s how to enable it:
Open JupyterLab and click the “Extensions” button in the left sidebar (it looks like a puzzle piece).
Search for “table of contents” in the extensions search bar.
If the “Table of Contents” extension is not already installed, click the “Install” button. If it’s installed but not enabled, click the “Enable” button.
You should now see a “Table of Contents” tab in the left sidebar. Click this tab to display the TOC for the currently open notebook.
The TOC will automatically update as you add, remove, or edit Markdown headers in your notebook.
Customizing Your TOC
Both the toc2 extension for Jupyter Notebook and the built-in TOC extension for JupyterLab offer customization options, including:
- Collapsing/Expanding sections
- Displaying a TOC cell within the notebook (Jupyter Notebook only)
- Limiting the depth of the TOC
- Numbering sections and subsections
- Changing the appearance of the TOC
For the toc2 extension in Jupyter Notebook, you can customize these settings by clicking the “Table of Contents Settings” button in the toolbar (next to the TOC button).
In JupyterLab, you can access the settings for the TOC extension by clicking the gear icon in the “Table of Contents” tab of the left sidebar.
Conclusion
We’ve covered how to add a table of contents to both Jupyter Notebook and JupyterLab, as well as how to customize the appearance and behavior of your TOC. With a well-structured TOC in place, you and your colleagues can easily navigate and collaborate on complex data science projects, leading to more efficient and effective work.
Remember to share this tutorial with your fellow data scientists and software engineers to help them add TOCs to their Jupyter and JupyterLab notebooks!
Installing Table of Contents extension to Jupyter notebook
Table of contents 2 is a very useful extension to Jupyter notebook that allows you to have a nested outline with links to all the Markdown headings in a Jupyter notebook. This is basically essential when you’re working with a notebook of any real length. I don’t know why it isn’t just a standard feature in Jupyter.
Figuring out how to install it is a bit annoying as instructions are poorly written across several Github repos, but the process is actually very simple (if a little hacky). Assuming you followed my instructions on setting up a virtual environment in Python 3, activate it with (substitute your own path if needed):
Now install jupyter_contrib_nbextensions. This bundles a bunch of extensions to Jupyter, as well as a configuration panel that will be added to the Jupyter interface.
This command is needed to complete the installation of the extensions to Jupyter itself:
Now on the main Jupyter page, click the tab “Nbextensions”, then check the box for “Table of contents (2)”.
Now when you start a notebook, click the “Table of Contents” button, and you’ll get a sidebar on the left with your table of contents. Voila!