mkdocsとnotebookをつなげたい

mkdocsという静的ページジェネレータがあります。
分析者としてはマークダウンとjupyter notebookを一つにまとめ、記録を残していきたくなります。そこでmkdocsとjupyterをつなげるパッケージを使用します。

準備

pip install mkdocs
pip install mkdocs-jupyter

また、今回はgithub pageにあげるので、githubにレポジトリをつくりローカルにクローンしておきます。

git clone レポジトリ

ドキュメントの作成とプッシュ

クローンしたディレクトリにmkdocsのプロジェクトを作成、jupyter notebookをドキュメントディレクトリにおきます。

mkdocs new my_report

mkdocs.ymlファイルをいじり、notebookの指定と、プラグインの取り込みを設定します。

nav:
- Notebook:おいたjupyterファイル.ipynb

plugins:
  - mkdocs-jupyter

あとは以下のコマンドを実行することで、github pageに上げることができます。

mkdocs gh-deploy