前記事 【📖nbdev2入門】Dockerによる環境構築と作業手順 - Qiita
nbdevは、ノートブック駆動開発プラットフォームです。
公式ドキュメント(nbdev - エンド ツー エンドのウォークスルー)から以下の手順を抜粋しました。
なお、コマンドで簡単に始められるように、GitHub周りは手順の最後にまとめて実施するようアレンジしてます。
- 環境のセットアップ
- プロジェクト作成
- 開発作業
- GitHubリポジトリへのプッシュ・設定
想定環境
- Windows11 Pro
- WSL2 Ubuntu
- Python 3.9以上 (pipでパッケージ管理)
1.環境のセットアップ
作業 | コマンド |
---|---|
nbdevをインストール | pip install nbdev |
WSL再起動 (nbdev_*コマンドが見つかるようにするため。) |
PowerShellでwsl --shutdown wsl
|
Quartoをインストール |
nbdev_install_quarto ※Python 3.9以上が必要 |
2.プロジェクト作成
以下のコマンドは、リポジトリとして初期化したいフォルダで実行すること。
作業 | コマンド |
---|---|
nbdevプロジェクトとして初期化 | nbdev_new |
Gitリポジトリとして初期化 | git init |
Git Hookインストール | nbdev_install_hooks |
セットアップできたか確認 (Quartoサーバ起動) |
nbdev_preview http://localhost:****/ へアクセス(ポート番号は起動のたびに変わる) ※自作ライブラリが読み込めなくて失敗するときは「pip install -e .」で編集可能インストールすること |
3.開発作業
作業 | コマンド |
---|---|
Jupyter Lab起動 | jupyter lab |
Quartoサーバ起動 (ドキュメント確認のため) |
nbdev_preview ※自作ライブラリが読み込めなくて失敗するときは「pip install -e .」で編集可能インストールすること |
(Notebookを編集する) | (Notebookを更新するとQuartoドキュメントがホットリロードされるはず。されないときはQuarto再起動を試すこと。) |
コミット前の確認 (テスト、ライブラリビルド) |
nbdev_prepare |
(Git コミット、プッシュ) | - |
4.GitHubリポジトリへのプッシュ・設定
作業 | コマンド |
---|---|
GitHubリポジトリへプッシュ | |
GitHub Pagesの設定 (必要に応じて) |
GitHubプロジェクトの設定ページで設定。 gh_pagesブランチのルートフォルダをドキュメント置き場に使う。 |