nikkie-ftnextの日記

イベントレポートや読書メモを発信

Python・Django・Sphinxの公式ドキュメントを翻訳できる設定を整えました(Transifexアカウントを作って翻訳プロジェクトに参加!)

はじめに

世界は、ひとつずつ変えることができる。1 nikkieです。

このたび、公式ドキュメントを翻訳できる設定を整えました!

目次

typoを見つけたらプルリクエストを出してます

過去に書いています。

ドキュメントを読んでいるとtypo(誤植)に気づくことってありますよね?
そんなとき私はなるべくプルリクエストまで作るようにしています。
Webに公開されているページは今後も見る人がいるでしょうし、その人も「あれ?」と思うでしょう。
できないときもあるのですが、「気づいた以上はなるべく直したい!」と時間を捻出してプルリクエストを作ります。

直近で作ったtypo修正プルリクエストはこちら

このように自分にできるボーイスカウト活動に勤しんでいましたが、1つ壁がありました。
それが、プルリクエストを送れない、公式ドキュメントの翻訳たち。

ですが、このたび一念発起して翻訳の設定をしたのです。

公式ドキュメントを翻訳できるように整えました

このたび以下のドキュメントについて整えました

必要だったのは、Transifexのアカウントだけでした。

Transifexのアカウント作成

Python Monthly Topicsにズバリな回があります。
この回が分かりやすく、「いっちょ翻訳の環境設定整えたるか!」となりました。

Python公式ドキュメントを翻訳しよう | gihyo.jp

https://app.transifex.com/signup/open-source/ からオープンソース用のTransifexアカウントを作成。
一時オープンソースではないアカウントを作る動線に入ってしまいましたが、この記事のおかげで正しい道に戻れました。

Python

上で紹介した記事にあるとおりです。

リポジトリも合わせてどうぞ2

https://explore.transifex.com/python-doc/python-newest/ からJapaneseの翻訳にJoinし、承認していただきます。

なお、この記事はPythonドキュメントの翻訳にいざなうだけでなく、DjangoSphinxのドキュメントの翻訳に踏み出せるリンクもあります(この記事を書いていて気づきました)。

Django

Transifexまわりはこちら

https://explore.transifex.com/django/django-docs/ からJapaneseの翻訳にJoinします。
djangoja Discord3で承認もお願いしました。

翻訳についてはこちらをどうぞ

Sphinx

https://explore.transifex.com/sphinx-doc/sphinx-doc/ からJapaneseの翻訳にJoinします。

ここに行き着くまでに、翻訳のGitHubリポジトリから

jaのRTD Projectを経由しました(Python Monthly Topicsは高速道路を引いていて偉大です)

ちょっとしたtypoの修正

Django

https://docs.djangoproject.com/ja/5.0/topics/async/#sync-to-async

「スレッドse-hu」というtypoがあります。

これはTransifex上は修正済みだったので、反映待ちです(気付いて動かれた方に感謝)

Sphinx

https://www.sphinx-doc.org/ja/master/man/sphinx-build.html#cmdoption-sphinx-build-d

日本語訳をもう少しこなれさせられるなと感じたので修正。
反映されました。

Since Sphinx has to read and parse all source files before it can write an output file, the parsed source files are cached as “doctree pickles”.

Sphinxは出力ファイルに書き込む前に、すべてのソースファイルを読み込みパースしなければならないため、パースされたソースファイルは "doctree pickle"としてキャッシュされます。

さらにこなれた案をお持ちの方はぜひ翻訳にご参加ください!

終わりに

PythonDjangoSphinxの公式ドキュメントを翻訳できる設定を整えました!
私はガッツリ翻訳に入る気はないのですが、気付いたtypoにプルリクエストを送る一環で、これらのドキュメントも小さな改善を積み重ねていきます。

翻訳に興味のある方、以下のPython Monthly Topicsが必見ですよ。
Python公式ドキュメント以外も翻訳プロジェクトが紹介されています

最後に、『プログラマが知るべき97のこと』よりボーイスカウト・ルールです。

来た時よりも美しく


  1. 世界は、ひとつずつ変えることができる。|富士フイルムの技術
  2. このリポジトリに気付いた範囲でissueを立ててきました
  3. 参加リンクは https://twitter.com/django_ja のbioをどうぞ