海外PyCon発表修行レポート2015

第6回(最終回) PyCon Korea 2015参加レポートとSphinx発表

この記事を読むのに必要な時間:およそ 5 分

Sphinxオフィスアワー

発表のあとはオフィスアワーです。オフィスアワーは,発表者がこの時間帯はここにいるよ,という企画で,だれでも発表者に質問したり相談したりできます。

Q&Aを終え,オフィスアワーの部屋へ向かう途中,홍민희(ホン・ミンニ)さんと話をしました。PyCon Korea座長の배권한(ベ・グォナン)は,彼のことを韓国のSphinxスターだと言って筆者に紹介してくれました。彼は5年前からSphinxを使い始めたそうなので,ユーザ歴は筆者と同じかもしかしたら長いかもしれません。

筆者(左)と,ミンニさん(右)

筆者(左)と,ミンニさん(右)

ミンニさんの話では,彼がSphinxを使い始めた頃はドキュメンテーションへの関心がほとんどなかったけれど,2014年末にThe Hacker's Guide to Pythonの韓国語版が発売されてから,ドキュメンテーションへの関心が高くなり,多くの人がSphinxに興味を持ったそうです。この本の3章で,ドキュメンテーションの方法としてSphinxとautodocが紹介されています。本と同じautodocについて,ちょうど関心が高まった今回のPyCon Koreaで紹介できたのはとても良いタイミングでした。

ドキュメンテーションへの関心が高まってきていますが,実践している人はそう多くないそうです。ミンニさんによると「韓国ではドキュメントを書かない人が多い」のだそうです。同様に本を書く人も少なく,Python本は翻訳本に頼っている状況で「日本では多くの人が日本語でPythonの本を書いていてうらやましい」ということでした。日本でPythonがよく使われるようになった頃は,日本語で書き下ろされたPython本はほとんどなく,そういった本が増えてきたのはここ数年のことです。また,ドキュメントを書かないということについても,日本でもよく聞く話です。そういった日本での状況をミンニさんに伝え,Sphinxのようなツールを使う事でドキュメントを楽に書く方法が広まって,書くことが楽しいと感じられれば,みんな書くようになるんじゃないか,と伝えました。

autodocのトラブルシューティング中

autodocのトラブルシューティング中

オフィスアワーには,他にRead the Docsでautodocがうまく動作しないことについて相談が持ち込まれました。Read the DocsはSphinx専用のドキュメントホスティングサービスです。reSTファイルに書いた内容のドキュメントビルドだけでなく,autodoc機能にも対応しているのですが,彼の環境ではなぜかautodocのドキュメント部分だけがうまくビルドできない状況でした。原因は,Pythonバージョンの違いによるもので,ビルドログを見て原因がわかったため,Pythonのバージョン指定を変更してすぐに解決できました。

The Hacker's Guide to Pythonの翻訳本や,筆者の発表をきっかけにして,autodocを使ったドキュメント生成やSphinxの利用事例が,こらからもっと増えていくことを期待しています。来年はそういう方達とまた色々な話ができると嬉しいですね。

Sphinxオープンスペース

オープンスペースは,だれが何を話してもよい自由発表枠です。参加登録は,付箋になにをやるか書いて空いている枠に貼るだけです。

知り合いのスタッフから,オープンスペースやろうよ,と勧められたこともあり,筆者は2日目の夕方にオープンスペースの時間を持ちました。韓国語が話せないため,⁠Sphinx(English⁠⁠」と書いて貼ったところ,⁠この人Sphinxのメンテナ⁠という紹介が書き足されていましたが,Englishと書いたためかSphinxの話をしに部屋に来たのは서승효(ソ・スンヒョ)さん1人でした。

“この人Sphinxのメンテナ⁠と紹介された

“この人Sphinxのメンテナ”と紹介された

スンヒョさんとはたくさんの話をしましたが,そのなかに,どうやってSphinxのメンテナになったのですか? という質問がありました。発表のQ&Aでも同じ質問があり,また,これまでの海外PyCon発表修行をしている中でも,オープンソースのメンテナになる方法は何度か訊かれました。ここでは,筆者がSphinxのメンテナになった経緯について紹介します。

筆者は初めはユーザの1人でした。当時のSphinxの多言語化機能は色々な問題があり,そこで遭遇した問題を報告したり,Pull Requestで修正パッチを送ったりしていました。それを続けていた頃に,作者のGeorgがSphinxのメンテナンスにあまり時間を割けなくなったこともあり,メンテナを募集したのでそこに手を挙げて参加しました。運良くメンテナになれた,とも思いますが,その前からバグ報告やパッチ作成を継続していたことでメンテナとして開発に参加する準備ができており,手を挙げる勇気を持てたのだと思います。

難しいのはメンテナを続けることです。メンテナ募集のタイミングで筆者も含め10人がメンテナとして参加しました。しかし,8人は3年間で一度もコードをコミットせず,あと1人も数ヶ月活動したのち音信不通になってしまいました。筆者はそれほど開発速度が速いほうではありませんが,かわりに時間をかけてSphinxをメンテナンスしています。時間の割になかなか数をこなせないのは心苦しいところがありますが,メンテナンスを継続し,チケットやMLを通してユーザとの対話を続けることも重要だと思っています。これからもWork-Life-"OSS" バランスを保ちつつ,続けていきたいと思います。

Sphinxのメンテナは不足しています。やってみたい,と思う方はぜひご連絡ください

PyCon Korea 2015参加レポートのおわりに

今回,PyCon Koreaでは言葉が分からない中でも,オフィスアワーやオープンスペースを使う事でSphinxについてのディスカッションを持つことができました。PyCon APACの夜市のときのように,多くの人にSphinxのことを伝えることも重要ですが,一開発者として今回のような深い議論ができる機会はとても楽しいものでした。来年,韓国ではPyCon APACが開催されます。海外からの参加者がどのくらいの割合になるのかは分かりませんが,APAC地域の多くのPythonエンジニアが集結するイベントになると思います。筆者もそこに参加して,新しいSphinxのネタを共有したり,他の技術者たちと議論したいと思います。

おわりに

今回のレポートで「海外PyCon発表修行レポート2015」は終わりとなります。2月のプロポーザル作成から8月末のPyCon Koreaまで,およそ7ヵ月間のあいだPyConの発表準備とレポート執筆に充ててきました。実のところ,短期間でたくさんのカンファレンスに参加したこともあり,最後のほうは多少疲れも出てきていました。しかし,どのカンファレンスでも思いがけない技術や人との出会いがあり,また自分から行動することで常に多くのフィードバックを得ることができました。多少大変なところはありましたが,とても楽しい時間を過ごせました。これから英語のリスニングを鍛えて,来年も海外PyConで発表や参加する機会を持ちたいと思います。

日本では10月9日(金⁠⁠~12日(月)PyCon JP 2015が開催されます。筆者もこのカンファレンスでSphinxのautodocについて発表させていただきます。参加するみなさんは,ぜひスピーカーに質問したり,海外から来て困っている人に話しかけてみてください。きっとかけがえのない体験ができると思います。そして是非,海外カンファレンスでの発表にもチャレンジして,この楽しさを体験してもらえればと思います。

著者プロフィール

清水川貴之(しみずかわたかゆき)

ドキュメンテーションツールSphinxのメンテナ。2003年にZope2と出会い,それがオープンソース等のコミュニティー活動を始めるきっかけとなった。

Sphinx-users.jp運営。一般社団法人PyConJP理事。株式会社ビープラウド所属。

著書/訳書:「Pythonプロフェッショナルプログラミング第2版」「Sphinxをはじめよう」「Pythonプロフェッショナルプログラミング」「エキスパートPythonプログラミング」。

運営・参加イベント:Python mini Hack-a-thon主催,Sphinx+翻訳Hack-a-thon主催,PyCon JP 2011-2014運営

サイト:http://清水川.jp/
Twitter:@shimizukawa