Skip to content

pyconjp/pycamp.pycon.jp

Repository files navigation

pycamp.pycon.jp

Documentation Status

ビルド環境準備

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

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

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

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で記述しています