Comment puis-je ajouter une table des matières à une ipython notebook?

Il y a un ipython nbextension qui construit une table des matières pour un ordinateur portable. Elle semble être la seule à fournir des outils de navigation, pas à la section de pliage.

Ici est une option de plus sans trop de JS de tracas: https://github.com/kmahelona/ipython_notebook_goodies

Il y a maintenant deux paquets qui peuvent être utilisés pour gérer Jupyter extensions:

1. jupyter_contrib_nbextensions qui installe des extensions, y compris la table des matières;

2. jupyter_nbextensions_configurator qui fournit des interfaces utilisateur graphiques pour la configuration nbextensions sont activés (charge automatiquement pour chaque ordinateur portable) et fournit des commandes pour configurer le nbextensions' options.

Mise à JOUR:

À partir de versions récentes de jupyter_contrib_nbextensions, au moins avec conda vous n'avez pas besoin d'installer jupyter_nbextensions_configurator car il est installé avec ces extensions.

Voici ma démarche, maladroit comme il est, et disponible en github:

Mettre dans le premier cahier de la cellule, l'importation de cellules:

from IPythonTOC import IPythonTOC

toc = IPythonTOC()

Quelque part après l'importation de cellules, les mettre dans le genTOCEntry cellulaire, mais ne l'exécutez pas encore:

''' if you called toc.genTOCMarkdownCell before running this cell, 
the title has been set in the class '''

print toc.genTOCEntry()

Ci-dessous la genTOCEntry cellulaire, faire une table des matières de la cellule comme un abattement de cellules:

<a id='TOC'></a>

#TOC

Que l'ordinateur portable est élaboré, mis cette genTOCMarkdownCell avant de commencer une nouvelle section:

with open('TOCMarkdownCell.txt', 'w') as outfile:

    outfile.write(toc.genTOCMarkdownCell('Introduction'))

!cat TOCMarkdownCell.txt

!rm TOCMarkdownCell.txt

Déplacer le genTOCMarkdownCell au point dans votre ordinateur où vous souhaitez commencer une nouvelle section et faire de l'argument de genTOCMarkdownCell la chaîne de titre pour votre nouveau l'article, puis l'exécuter. Ajouter un abattement de cellules de droit et de copier la sortie de genTOCMarkdownCell dans le démarque de la cellule qui commence votre nouvelle section. Ensuite, allez à la genTOCEntry cellule près du haut de votre ordinateur portable et de l'exécuter. Par exemple, si vous faites l'argument de genTOCMarkdownCell comme indiqué ci-dessus et de l'exécuter, vous bénéficiez de cette sortie
pour coller à la première démarque des cellules de votre nouvellement indexée section:

<a id='Introduction'></a>

###Introduction

Puis, quand vous allez vers le haut de votre ordinateur portable et de les exécuter genTocEntry, vous obtenez la sortie:

[Introduction](#Introduction)

Copier le lien de la chaîne et de le coller dans la table des matières démarque de la cellule comme suit:

<a id='TOC'></a>

#TOC

[Introduction](#Introduction)

Après vous modifiez la table des matières de la cellule d'insérer le lien de la chaîne et puis vous appuyez sur maj-entrée, le lien vers votre nouvel article apparaîtra dans votre ordinateur portable Table des Matières comme un lien web et en cliquant dessus, la position du navigateur de votre nouvel article.

Une chose que j'oublie souvent c'est qu'en cliquant sur une ligne dans la table des matières rend le navigateur sauter à la cellule, mais ne pas le sélectionner. Quelle que soit la cellule est active lorsque nous avons cliqué sur la table des matières lien est toujours actif, et un vers le bas ou flèche haut ou maj-entrée se réfère toujours cellule active, pas la cellule, nous avons obtenu en cliquant sur le COT lien.

Introduction

Comme @Ian et @Sergey l'ai mentionné, nbextensions est une solution simple. Dans l'élaboration de leur réponse, voici un peu plus d'informations.

Qu'est-ce que nbextensions?

La nbextensions contient une collection d'extensions
qui ajoutent des fonctionnalités à votre Jupyter portable.

Par exemple, pour ne citer que quelques extensions:

• Table des Matières

  

• Pliable en-têtes de

  

Installer nbextensions

L'installation peut être faite par Conda ou PIP

# If conda:
conda install -c conda-forge jupyter_contrib_nbextensions
# or with pip:
pip install jupyter_contrib_nbextensions

Copier les fichiers css et js

Pour copier le nbextensions' fichiers javascript et css dans le jupyter du serveur de répertoire de recherche, procédez de la manière suivante:

jupyter contrib nbextension install --user

Bascule extensions

Notez que si vous n'êtes pas familier avec le terminal, il serait préférable d'installer nbextensions configurateur (voir la section suivante)

Vous pouvez activer/désactiver les extensions de votre choix. Comme la documentation mentionne, pour le générique de commande est:

jupyter nbextension enable <nbextension require path>

De façon concrète, pour permettre à la Table des Matières (ToC) extension, faire:

jupyter nbextension enable toc2/main

L'installation de la Configuration de l'interface (facultatif mais utile)

Que la documentation qui lui dit, nbextensions_configurator fournit config des interfaces pour nbextensions.

Il ressemble à la suivante:

De l'installer si vous utilisez conda:

conda install -c conda-forge jupyter_nbextensions_configurator

Si vous n'avez pas Conda ou ne voulez pas l'installer par Conda, puis effectuez les opérations suivantes 2 étapes:

pip install jupyter_nbextensions_configurator
jupyter nbextensions_configurator enable --user