pycamp.pycon.jp

• ビルドされたページ: http://pycamp.pycon.jp/
• Read the Docs のプロジェクトページ: Read https://readthedocs.org/projects/bootcamp-text/
• www.pycon.jp の説明ページ: https://www.pycon.jp/support/bootcamp.html

ビルド環境準備

Ubuntu環境でのフォントインストール

$ sudo apt update
$ sudo apt install fonts-noto-cjk
$ rm -rf ~/.cache/matplotlib

コンテナ環境を利用したビルド環境準備

• この手順は必須ではありません

• コンテナ環境を利用して、貢献者同士の開発環境を統一することができる
  設定ファイルは .devcontainer/devcontainer.json

• Visual Studio Codeの拡張機能を利用する場合 (ローカル環境)
  Visual Studio Code を使用して Docker コンテナーを開発環境として使用する - Training | Microsoft Learn

• GitHub Codespacesを使用する場合 (リモート環境)
  GitHub Codespacesのクイックスタート

How to build

$ git clone git@github.com:pyconjp/pycamp.pycon.jp.git
$ cd pycamp.pycon.jp
$ python3.12 -m venv env
$ . env/bin/activate
(env) $ pip install -r requirements.txt
(env) $ make html
(env) $ open build/html/index.html

テキスト修正の提案方法

1. pycamp.pycon.jpリポジトリをforkする
2. forkしたリポジトリをcloneする
3. cloneしたリポジトリのmasterに、修正したテキスト内容をpushする
4. PRを作成する

reStructuredTextとmarkdownについて

• Python Boot Campテキスト(source/textbook/ 以下)と貢献者一覧ページ(source/organize/3_contributers.md)はmarkdownで記述しています
  • markdownはSphinxの拡張表現(directive)に対応したMySTを使っています
  • MySTの記述ルールについてはmyst-parserを参照してください
  • とはいえ、directiveを使わないのであれば通常のmarkdownと同じです
• それ以外のページはreStructuredTextで記述しています