jupyter-bookの覚え書き#

Install#

pip install -U jupyter-book

Note

Windowsでinstall後にコマンドが見つからないとなった。 環境変数PathにpythonのScriptディレクトリを追加したらうまくいった

新規サイト作成時#

新規のディレクトリmysiteを作るため、1階層上で実行する

jupyter-book create mysite

なお、jupyter-bookは省略してjbでも通る

html化#

mysiteディレクトリの1階層上で実行

jupyter-book build mysite

もしくは作ったディレクトリの中で

jupyter-book build .

デフォルトでは更新されたファイルだけ再構築されるので、2回目以降はちょっと早くなるはず

定義リストを使えるようにする#

_config.ymlに以下の行を追加する

parse:
  myst_enable_extensions:
    # don't forget to list any other extensions you want enabled,
    # including those that are enabled by default!
    - dollarmath
    - linkify
    - substitution
    - colon_fence
    - deflist

一番下のdeflistがdefinition listの機能フラグ。それより上はデフォルトで有効になっている機能。書いておかないと無効になっちゃう

Tip#

  • コンテンツは任意の階層化が可能。TOCにでなくても検索したら出てきた

  • 全ページ再作成したい時は--allフラグ

    jupyter-book build --all mybookname/

.venvを置くとエラー#

同じディレクトリに.venvディレクトリを作ってjbを実行するとエラーでhtml生成ができなかった。
.venvディレクトリの中まで実行しようとしていたのが原因の様子。
実行対象外ディレクトリに指定してあげるとエラーが出なくなった。

Exclude pages from your build

exclude_patterns:
  - .venv/*