Jupyter Notebook で Table of Contents(目次)アドオンを導入する方法

Python初心者です。

Jupyter Notebookに目次機能があることを知ったものの、導入につかえてしまったので、メモとして導入方法を記します。

本稿を読んでできるようになること

• Table of Contentsという、Jupyter Notebookにおける非常に有用なアドオンを使用できるようになる
  • 直訳すると「目次」。マークダウンのhタグに応じた見出しを自動生成してくれる機能。

利用開始手順

1.インストール

Jupyter Notebook上でターミナルを起動し、以下を実行する^{1 2}。

# a. Table of Contents等をおさめたアドオン群をインストールする
pip install jupyter_contrib_nbextensions

# b. aを設定画面で表示させるためのCSSファイル・jsファイルをインストールする
jupyter contrib nbextension install --user


# c. Jupyter Notebookのアドオン管理用のライブラリをインストールする
pip install jupyter_nbextensions_configurator

# d.cを有効化する
jupyter nbextensions_configurator enable --user

設定&使用

• Jupyter Notebookを終了し、再起動。画面上部から「Nbextensions」が選択できるようになっているのでクリックし、「Table of Contents(2)」の脇にチェックをつける。
• 画面下部にTable of Contents(2)の設定画面が表示されるので自由に設定する。
  • 「Automatically number notebook's sections」にチェックをつけておくと、マークダウンのhタグに自動的に数字を付けてくれます。おすすめです。
• Notebookをつくり、画面上部の三本線アイコンをクリックすることで目次を表示可能となる。

まとめ

• Jupyter Notebookでアドオンを使用できるようになるまでをシンプルにまとめた記事が、日本語では書かれていないように感じたのでまとめてみました。(記事自体はあったのですが筆者環境でエラーが止まりませんでした...)
• Table of Contents以外にも多数のアドオンがあるようなので、機会があれば有用なアドオン群をまとめて列挙できればと思います

ご覧くださりありがとうございました。

(以上)

1. Jupyter notebook extensions(https://github.com/ipython-contrib/jupyter_contrib_nbextensions) ↩

2. Jupyter Nbextensions Configurator (https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator) ↩