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

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

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

Sphinxの発表,オフィスアワー,オープンスペース

Sphinx発表

カンファレンス1日目,8月29日(土)の15:00から,Sphinxのautodoc機能についての発表を行いました。この発表では,Sphinxの自動ドキュメント機能を使うと,Pythonプログラムの充実したドキュメントを手軽に作れることを紹介しました。発表の大筋はPyCon APAC 2015で行った発表で紹介していますので,割愛します。

Sphinx autodoc の発表を見に来てくれた皆さん(演台から撮影)

Sphinx autodoc の発表を見に来てくれた皆さん(演台から撮影)

発表では,これまでの海外PyCon発表修行と同様,はじめに演台からの撮影を行いました。PyCon Koreaでは英語の案内や発表がほとんどなかったため,どのくらいの人が来てくれるか心配だったのですが,撮影時点で70名ほど,最終的には100名ほどの参加者が発表を聴いてくれました。

発表の始めに,韓国語で挨拶したところ大きな拍手をもらえたので,こういう小ネタをちょっと挟んでおくとお互いの緊張がほぐれて良いですね。緊張がほぐれたところで,Sphinxとドキュメンテーションに関する4つの質問を行いました。

  • Sphinxを知っていますか?-60%
  • Sphinxを使っていますか?-30%
  • Docstringを知っていますか?-90%
  • docstringを使ってAPIドキュメントを書いたことがありますか?-10%

筆者はこの結果を見ておどろきました。これまで台湾,シンガポール,マレーシアで同じような質問をしてきましたが,Sphinxの知名度はそれほど高くありませんでした。しかし韓国では多くの人がSphinxに関心をもっていました。

発表を40分で終え,その後のQ&Aでは10個の質問をもらいました。ほとんどの質問が韓国語で,2つは日本語で質問をいただきました。司会を務めてくれたジェオンさんが,韓国語での質問を日本語に翻訳してくれました。筆者はこれに英語で答えたので,会場は韓国語,日本語,英語の飛び交うちょっと面白い状態でした。

質問の内容は,以下のように幅広い内容でした。

  • Sphinxはパッケージではなく1モジュールでもautodocの対象にできますか?
  • 日本でSphinxを使って出版した事例はありますか?
  • Sphinxを使って出版物を書くメリットは何ですか?
  • SphinxでREST APIのドキュメントを自動生成できますか?
  • Swaggerと連携できますか?
  • どうやってSphinxのメンテナになったのですか?
  • reSTのインデントは3スペースだけど,なにか慣例はありますか?
  • Sphinxのdoctestから自動的にテストを生成できますか?

Sphinxを出版に使用するメリットはいくつかあります。一つ目は,著者がテキストエディタ上だけでなく,SphinxのHTMLやPDFの出力を閲覧することで視点が変えられること。2つ目は,SphinxのBuilderプラグインを実装することで提出原稿のフォーマットを出力できるため,Sphinxの原稿だけをみていられることです。

Q&Aでこのように多くの方から質問をもらったのはPyCon Koreaが初めてだったため,韓国で多くの人がSphinxに興味を持ってくれていると感じられました。Q&Aは次のセッションがはじまる時間いっぱいまで続きました。

著者プロフィール

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

ドキュメンテーションツール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