Date: 2018-04-01
Tags: sphinx

Sphinx + 翻訳 hack-a-thon 2018.04 #sphinxjp

SphinxのHack-a-thonイベントに参加してきました。 今日は、仙台から来た人、Sphinxのドキュメント翻訳する人、など8名が参加しました。

../../_images/attendees1.jpg

自分は、乳児の沐浴があるので17時で撤収しました。

イベント

Sphinx+翻訳 hack-a-thon 2018.04

参加者

@tk0miya, @shimizukawa, @KenOnodera1988, nskgch, @takuan_osho, @naru0ga, @cocoatomo, @usaturn

会場

タイムインターメディア社(曙橋)

自己紹介、やること

../../_images/todos.jpg

やること

  • @tk0miya: 「Sphinx-1.8に向けてコード書きます」

  • @KenOnodera1988: 「2010年くらいから研究室でSphinxを使っています。研究室や仕事でSphinxで書いても使ってもらえないというジレンマが。広めようにも仙台にSphinx/Pythonコミュニティがないので広めづらい。仙台でコミュニティを作りたい。勝手にやっていいんでしょうか?(いいとも!)」

  • nskgch: 「Sphinxドキュメント翻訳の手伝いをしてます。今日もやります」

  • @takuan_osho: 「Sphinxはユーザーとしてけっこう前から使ってます。今日やることはいまから考えます」

  • @naru0ga: 「LibreOfficeの方からきました。ドキュメント作成ではあまりLibreOfficeでは書いてなくて、レポートからLibreOfficeに出してレタッチしてPDF化して提出するという使い方をしています。Sphinxで書いたものを同様にできたら面白いかなと今思い付きましたw」

  • @shimizukawa「SphinxのIssueをたくさん振られたので倒していきます。あと、Sphinx公式ドキュメントの翻訳を自動的にサイトに反映する仕組みを先日刷新したので、その自動化をもうちょっと進めます」

  • @cocoatomo: 「Python公式ドキュメント https://docs.python.org/ja/ の翻訳をしてます。Python-3.7がリリースされそうなので、メジャーバージョンが出たときにTransifexの切り替えをどういう手順でやるかをWikiにまとめる作業をします。もしPythonドキュメントを読んで分からない日本語とかあったら教えてください」

  • @usaturn: 「普段はインフラ屋でクラウドフォーメーションとか使ってます。今日は社内勉強会でSphinxを紹介するのでそのプレゼン資料を作ります」

自分がやったこと

  1. http://www.sphinx-doc.org/en/stable/ を再ビルドしてcanonical hrefにmasterを指定

    Sphinxプロジェクトは stable ブランチを廃止しました。

    • master: 開発中最新メジャーバージョン(未リリース)

    • stable: 以前は、リリース済み最新メジャーバージョン(廃止)

    • 1.7: リリース済みメジャーバージョン(新規)

    • 1.6: リリース済みメジャーバージョン(新規)

    • ...

    上記のように、stableを廃止して、リリース済みバージョンはバージョン番号でドキュメントを持つようにしました。この結果、URLが以下の様に変わりました。

    変わったんですが、以前からリンクしているサイトなどは /stable/ を指していてGoogleのクローラーもやってくることもあり、Sphinxの何かをGoogle検索すると /stable/ にたどり着いてしまう状態でした。

    ということで、Google検索の結果を /master/ に向けるために、ReadTheDocsの設定を変えて、 Sphinxドキュメントのヘッダにもテンプレートで設定 して、stableドキュメントを再ビルドしました。

    とは言え、 /stable/ はもう廃止したURLなので、ReadTheDocsのリンクでアクセスされないように、設定で非公開にして、 http://www.sphinx-doc.org 上ではリンクを提供しないように変更しました。(本当は /stable/* にアクセスされたときに /master/* にリダイレクトしたかったけど、ReadTheDocsではできなかったのでしょうがない)

    ../../_images/hide-stable.png
  2. PRをいくつかレビューして、Issue見ました

おまけ