投稿ガイドライン

• Jupyter-book は 複数のコンテンツタイプ をサポートします。 Markdown のフレーバーが好まれます。
• ドキュメント内の各文は新しい行で始めてください。これにより、 より良い差分とプルリクエストを実現します。

ローカルでドキュメントを構築する

現在、ドキュメントでは ジュピターブック が使用されています。 ドキュメントをローカルで構築したり、プル リクエストを開く前にテストしたりするには、仮想環境を使用できます。

  # Create a new virtual environment
  $ python3 -m venv ./.venv
  # Activate the virtual environment
  $ source .venv/bin/activate
  # Install the necessary Python packages
  $ pip install -r requirements-book.txt
  # Build the docs
  $ jupyter-book build ./source
  # This will create the HTML files in ./source/_build/html

仮想環境を非アクティブ化するには:

  $ deactivate

Python 仮想環境の詳細については、Python ドキュメント ここ を参照してください。

本を出版する

この本は、ghp-import ツールを使用して GitHub ページで公開されています。

  # Use ghp-import
  $ ghp-import -n -p -f ./source/_build/html

これにより、jupyter-book によってビルドされた HTML ファイルが gh-pages ブランチにインポートされます。 詳細については、公式ドキュメント を参照してください。

これらの手順を支援するヘルパー スクリプト ./build-helper.sh がリポジトリに存在します。