旧ドキュメント翻訳方法

1.4ドキュメント翻訳

1.4ドキュメントの翻訳はGithub上での作業になります。

以下の手順で、本家リポジトリ revision 007bfddc1fc4977009e431cf9706408316b682af から revision f95baa1d8a8a96f843745118c38b7d13824a1e38 への差分訳を行なってください。

  1. issue トラッカーにアサインする。

    issue トラッカーから自分自身にアサインしてください。

  2. 和訳のソースドキュメントを入手する:

    git clone git://github.com/django-docs-ja/django-docs-ja.git
    
  3. Django プロジェクトの git リポジトリをクローンする:

    git clone git://github.com/django/django.git
    
  4. Django プロジェクトの git リポジトリで差分を取得する:

    cd django
    git diff 007bfddc1fc4977009e431cf9706408316b682af f95baa1d8a8a96f843745118c38b7d13824a1e38 docs/index.txt > diff.txt
    
  5. diff.txt の内容に基づいて、和訳を修正する。

    新規に翻訳するセクションについては、もとの英訳をコメントアウトして残してください。参照:

    https://groups.google.com/forum/?fromgroups=#!topic/django-ja/yBAu2i6bN9Y

    注意: diff には、既存の他のドキュメントから、ほとんど変更なく移動してきたも のや、他のドキュメントにレイアウト変更されたものがあります。そのような diff を見つけたら、できるだけ、該当のドキュメントも編集するか、Issue にメモを残し てください。

  6. push/pull-request して、作業完了を Issue にポストして、クローズする。

    作業内容を誰かにチェックしてもらいたければ、 Issue をクローズせず、右側の枠 外にある 'Labels' から 'waiting for review' を選んで、「レビュー待ち」にして ください。

ルール

和訳では、75−80カラムで折り返してください。テキスト形式でも見栄えよくするためです。

和訳ドキュメント中にコメントで原文を残してください。 Sphinx クックブック が参考になります。

原則、英数字の前後にスペースを入れます。これもテキストの見栄えのためです。

専門用語に訳語を当てるときには、初出の箇所で、訳語(英語)のように書いてくださ い。固有名詞は大文字で始めます。一般名詞は、小文字ではじめます。 例:ディスパッチャー (dispacher)、 継承 (inheritance)

ビルド

Sphinx v1.1.3 でビルドできます。 プロジェクトのトップで:

make html

すれば _build ディレクトリ以下にビルドされます。