世界のsphinx事情 @ sphinxcon jp 2015

22
1 Takayuki Shimizukawa Sphinx co-maintainer Sphinx-users.jp

Upload: takayuki-shimizukawa

Post on 21-Jan-2018

1.632 views

Category:

Technology


0 download

TRANSCRIPT

Page 1: 世界のSphinx事情 @ SphinxCon JP 2015

1

Takayuki Shimizukawa

Sphinx co-maintainer

Sphinx-users.jp

Page 2: 世界のSphinx事情 @ SphinxCon JP 2015

おまえ誰よ

@shimizukawa(清水川)

Sphinx メンテナ

Sphinx-users.jp

一般社団法人PyCon JP 理事

Python mini hack-a-thon運営

2

Page 3: 世界のSphinx事情 @ SphinxCon JP 2015

3

Page 4: 世界のSphinx事情 @ SphinxCon JP 2015

gihyo.jpさんで記事を書きました

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

http://gihyo.jp/news/report/01/overseas-pycon-presentation-training-2015/

4

Page 5: 世界のSphinx事情 @ SphinxCon JP 2015

2015/6/5(金)~6/8(月) 今年3回目のPyCon, 参加 ??名(700くらいかな)

台湾のSphinx事情 発表参加者: 50名 Q&A: 4個

Sphinxを知ってる人 -> 50人中3人 Sphinxで作られているPython公式ドキュメントは全員が読んだことがある

reStructuredText記法を知ってる -> 10人 Markdown記法を知っている -> 0人 ドキュメントを書いている -> 0人 Sphinxって? -> 会社名?(という人も居た)

PyCon APAC 2015 (Taiwan)

5

Page 6: 世界のSphinx事情 @ SphinxCon JP 2015

PyCon Singapore 2015

2015/6/17(水)~6/19(金)

今年6回目の開催、参加 100名

シンガポールのSphinx事情

発表参加者: 13名

Q&A: 1個

不明(たぶんそんなに使われていない)

シンガポールのPyConが学会っぽい雰囲気が強い

PyData系の話が多かったイメージ

6

Page 7: 世界のSphinx事情 @ SphinxCon JP 2015

EuroPython 2015

2015/7/20(月)~7/26(日)

今年14回目の開催, 参加1,100名

ヨーロッパのSphinx事情

発表参加者: 100名

Q&A: 4個

みんな普通に使っている

Pythonコードから生成するautodocもあたりまえ

「"ドキュメントを書く"とは何か」、にフォーカスが移っている

7

Page 8: 世界のSphinx事情 @ SphinxCon JP 2015

PyCon Malaysia 2015

2015/8/21(金)~8/23(日)

今年初めてのPyCon, 参加 110名

マレーシアのSphinx事情

発表参加者: 10名

Q&A: 2個

不明(そんなに使われてなさそう)

"docstringを書いたことがある人" -> 40人中、20人

"docstringでAPIリファレンスを生成したことがある人" ->0

8

Page 9: 世界のSphinx事情 @ SphinxCon JP 2015

PyCon Korea 2015

2015/8/29(土)~8/30(日)

今年2回目のPyCon, 参加 650名

韓国のSphinx事情 発表参加者: 100名

Q&A: 10個

Sphinxを知っていますか? - 60%

Sphinxを使っていますか? - 30%

Docstringを知っていますか?- 90%

docstringを使ってAPIドキュメントを書いたことがありますか? - 10%

9

Page 10: 世界のSphinx事情 @ SphinxCon JP 2015

PyCon JP 2015

2015/10/08(金)~11/11(月)

今年5回目のPyCon, 参加 602名

日本のSphinx事情

発表参加者: 100名

Q&A: 3個

Sphinxを知っていますか? - 90%

Docstringを知っていますか?- 90%

docstringを使ってAPIドキュメントを書いたことがありますか? - 10%

10

Page 11: 世界のSphinx事情 @ SphinxCon JP 2015

11

Page 12: 世界のSphinx事情 @ SphinxCon JP 2015

さまざまな情報源

書籍 Sphinxをはじめよう (O'reilly) SoftwareDesignのSphinx連載2015年4月号~ 他

ネット sphinx, docutils sphinx-users.jp

イベント SphinxCon PyCon JP Sphinx+翻訳 Hack-a-thon Sphinx Tea Night

12

5. Sphinxの情報源

Page 13: 世界のSphinx事情 @ SphinxCon JP 2015

Sphinxをはじめよう(O'Reilly 2013)

Sphinx のみを扱った電子書籍

紙の本で100ページ相当

Sphinxのインストールから、HTML, PDF, EPUBの出力方法について、reSTの記法について。

付録に、よく使うreSTの文法を掲載

Sphinxを始める人、必携の書!

本日、2刷り & PDF!

13

5. Sphinxの情報源 -書籍

http://www.oreilly.co.jp/books/9784873116488/

Page 14: 世界のSphinx事情 @ SphinxCon JP 2015

SoftwareDesign Sphinx連載

2015年4月号~ Sphinx 連載開始! 6ページ/号, Sphinx短信を不定期掲載

4月: Sphinxで始めるドキュメント作成術 5月: 議事録を書こう(前編) 6月: 議事録を書こう(後編) 7月: テーブルを使いこなそう 8月: 目次,用語集,索引を付けよう 9月: サイトを作ろう(前編) 10月: サイトを作ろう(後編) 11月: HTMLテーマをカスタマイズしてみよう 12月: さまざまな方法で図を作ろう 1月: テキストマークアップから図を生成する

14

5. Sphinxの情報源 -書籍

http://gihyo.jp/magazine/SD/archive/2015/201504

Page 15: 世界のSphinx事情 @ SphinxCon JP 2015

エキPy / PyPro1, 2

いくつかのPythonの本に、Sphinxを扱った章があります。

コラムで触れている本も含めるともう何冊かありそう

15

5. Sphinxの情報源 -書籍

PyPro 1 エキPy

2012年 2010年

PyPro 2

2015年

Page 16: 世界のSphinx事情 @ SphinxCon JP 2015

Sphinx, docutils本家ドキュメント

16

5. Sphinxの情報源 -ネット

Sphinx本家: http://sphinx-doc.org/

Docutils本家: http://docutils.sourceforge.net/

英語です

Page 17: 世界のSphinx事情 @ SphinxCon JP 2015

本家ドキュメントにはない、さまざまな情報を複数の切り口で提供。MLの案内もここに。

サイト自体Sphinxで作っています

Twitter: @sphinxjp #sphinxjp

Slack: sphinxjp.herokuapp.com

Sphinx-users.jp

17

5. Sphinxの情報源 -ネット

Page 18: 世界のSphinx事情 @ SphinxCon JP 2015

Sphinx, docutils本家ドキュメントの翻訳

リファレンスを日本語に翻訳してあります

Sphinx: http://docs.sphinx-users.jp/ 90%翻訳済み

Docutils: http://docutils.sphinx-users.jp/一部翻訳済み

18

5. Sphinxの情報源 -ネット

Page 19: 世界のSphinx事情 @ SphinxCon JP 2015

SphinxCon JP 2015

2012年以降、年に1回開催。

今年は 11月24日(火) 19時~渋谷にて開催

プレゼン6つ、LT3つ

Hack-a-thonやハンズオンは無し

参加者(10人~40人)

ドキュメントに関わる人

関連ツールに関わる人

時々出版関係者

19

5. Sphinxの情報源 -イベント

SphinxCon JP 2014sphinxjp.connpass.com

Page 20: 世界のSphinx事情 @ SphinxCon JP 2015

PyCon JP

20

5. Sphinxの情報源 -イベント

Pythonの年次イベント。Sphinx-usres.jpとして参加してイベントを併設しています。pycon.jp/2015/

ポスターセッション

スプリント

ハンズオン(有料)

Page 21: 世界のSphinx事情 @ SphinxCon JP 2015

Sphinx+翻訳 Hack-a-thon

月1回開催。週末の午後 (6h)

Sphinxや翻訳に興味のある人が集まって、それぞれ

自分の課題を進めたり、他の人に色々聞いたり、雑談したり。

参加者(4人~8人)

Sphinxに興味のある方

ドキュメントに興味のある方

翻訳に興味のある方

場所: 東京曙橋か新宿の某社

5. Sphinxの情報源 -イベント

21sphinxjp.connpass.com

hack-a-thon

Page 22: 世界のSphinx事情 @ SphinxCon JP 2015

Sphinx Tea Night (お茶会)

22

5. Sphinxの情報源 -イベント

月1回開催。平日の夜 (2h)

Sphinxや翻訳に興味のある人が集まって、雑談してます。

参加者(3人~6人)

Sphinxに興味のある方

ドキュメントに興味のある方

なんとなく雑談したい方

場所: 東京市ヶ谷のデニーズ

Tea Night