Skip to content

HowToBuild

TAKASE Arihiro edited this page Sep 24, 2024 · 12 revisions

ソースコードからのビルド

このページでは Python 3.13 のドキュメントをビルドする方法について解説します。別のバージョンでは 3.13 を適宜読み替えて手順を実行してください。

ディレクトリ構成

cpython/                   <- python/cpython をチェックアウトしたもの
   ...
   Doc/                    <- 原文
      locale/ja/           <- 新規に作成する
         LC_MESSAGES/      <- python/python-docs-ja をチェックアウトしたもの
            .tx/config     <- Transifex プロジェクトの設定ファイル
            c-api/         <- 翻訳ファイル (.po ファイル)
            ...
      build/html/          <- 出力されたファイル (任意の場所)
   ...

ドキュメントのクローン

ドキュメントは Python GitHub organization で管理されています。

まずは原文を管理している python/cpython のリポジトリをクローンします。

$ git clone https://github.com/python/cpython
$ cd cpython
$ git switch 3.13

次に訳文である python/python-docs-ja のリポジトリをクローンします。

このプロジェクトで扱う Sphinx の翻訳機能は Doc/locale/<翻訳先言語コード>/LC_MESSAGES/ というディレクトリ構成の下にある翻訳済みファイルを利用します。

python-docs-ja/LC_MESSAGES/ に相当する構成なので、次のようにクローンしてください。

$ cd Doc
$ git clone https://github.com/python/python-docs-ja locale/ja/LC_MESSAGES

以下の作業は Doc/ を作業ディレクトリとして行います。

Unix/macOS で仮想環境を作る

Unix では Doc/Makefile を使って仮想環境を作ります。

$ make venv
$ source venv/bin/activate

Windows で仮想環境を作る

Python の venv モジュールで仮想環境を作る場合は pip で Doc/requirements.txt に書いてある依存関係をインストールします。

$ python -m venv venv
$ .\venv\Scripts\activate
$ pip install --upgrade -r requirements.txt

ビルド

最後に翻訳を適用してドキュメントをビルドします。

ビルド結果は Doc/build/html 以下に出力されます。 出力される場所を変更するには、最後の build/html の部分を変えてください。

$ sphinx-build -j4 -D language=ja -D locale_dirs=locale -D gettext_compact=0 -E . build/html

自分が翻訳した結果をビルドして読みたい場合は、 Doc/locale/ja/LC_MESSAGES/ 以下にある .po ファイルを編集してから再度ビルドしてください。

翻訳済みリソースをTransifexからダウンロードする

翻訳の成果は Transifex からもダウンロードできます。

Transifex CLI

.po ファイルを一度にダウンロードするには Transifex CLI を使います。

https://developers.transifex.com/docs/cli に従ってバイナリをビルドするか、 https://github.com/transifex/cli/releases から適切なバイナリをダウンロードして PATH を通してください。

~/.transifexrc ファイルを以下のように作成します。

[https://www.transifex.com]
rest_hostname = https://rest.api.transifex.com
token = (API トークン)

Transifex 右上のユーザーアイコンから ユーザー設定 に進み、APIトークン の「トークン生成」をクリックして生成された API トークンを設定ファイルに貼り付けてください。

Python 3.13 の .tx/config は既に設定されていますので、CLI のコマンドを使って .po ファイルをプルできます。

cd Doc/locale/ja/LC_MESSAGES/
tx pull -l ja

自動ビルドに使用されているスクリプト

python / docsbuild-scripts は、Python ドキュメントを docs.python.org に自動でビルドするために使われているスクリプトです。