SphinxSphinx-users.jp

山田剛

#ssmjp 2016/07/29

おまえ誰よ

Yamada GO!!Web 広告配信会社のインフラエンジニアという名前の雑用係

最近の仕事 インターネットができないんです案件からサーバの調達、構築、運用管理 インフラ系サーバメイン (DNS 、 MAIL 、 Hadoop 等 )

好きな Linux ディストリ Gentoo / GNU Linux

好きな事 Gentoo Install Battle

最近のマイブーム Gentoo で systemd-nspawn

コミュニティ Sphinx-Users.JP, Python mini hack-a-thon

2

Twitter: usaturn

Sphinx-Users.JP「 Sphinx 」という Python のドキュメンテーションツールのユーザ会で活動しています。

3

現在、 @togakushi さん他、ユーザ会のメンバでSoftwareDesign にSphinx の記事を連載中！

突然のデモ その１

1. sphinx-quickstart2. 記述済みのテキストファイルをコピーする3. make html4. Web ブラウザで表示する

突然のデモ その２

1. conf.py を書き換える html_theme = 'bizstyle'

2. make html3. conf.py を書き換える

extensions = ['sphinxjp.themes.s6'] html_theme = 's6'

4. make html

Sphinx とは

reStructuredText をメインに記述したプレーンテキストをインプットし、様々なフォーマットをアウトプットするドキュメンテーションジェネレータです

マルチインプット、マルチアウトプット

インプットSphinx アウトプット

reST

Markdown

jpeg,png...

Excel

html

PowerPoint

HTMLman

PDFePub3

LaTeX

text

csv

gettext

json

reST(reStructuredText)reST は Python が生み出した軽量

マークアップ言語可読性が高い表現力が高い

表箇条書き図の表示

Markdown制約がありますが Markdown も

使えます。Sphinx のディレクティブ（命令）が使えな

い

Sphinx の特長 プレーテキスト

開発者がプログラムのソースコードを扱うのと全く同じ環境、道具 ( エディタ、バージョン管理ツール、 CI)を利用する事ができる。

バージョン管理しやすい 複数人で編集しやすい！

文書の分割、結合が楽

エディタの注意

文字コードを UTF-8 にするハードタブは使わない等幅フォントを使うreST の syntax ハイライトを探す

Sphinx の特長 構造化

階層構造を促され、文書作成が横道にそれにくいtoctree箇条書きセクション

Sphinx の特長 目的の情報へ到達しやすい

目的の情報への導線が豊富インデックスクロスリファレンス標準の検索窓

Sphinx の特長 ドキュメントの記述に集中できる

出力した時の見た目（体裁）と内容が分離している為、慣れればドキュメントの記述に集中する事ができる。 reST や Sphinx の記述に慣れる必要はある

Sphinx の特長 拡張性

有志が作成したさまざまな拡張があるテーマBlockdiag

拡張を自身で作成する事も可能 (Python)ホスティングサービス「 Read the

Docs 」

Sphinx のホスティングサービス

https://readthedocs.org/

Github や Bitbucket のリポジトリを参照してドキュメントを公開する事ができるサービス

ユーザ会の活動

ユーザ会サイト： http://sphinx-users.jp/commentSlack https://sphinxjp.herokuapp.com/メーリングリスト登録： http://www.python.jp/

mailman/listinfo/sphinx-userscommentイベント告知： http://sphinxjp.connpass.com/

commentTwitter アカウント： https://twitter.com/

sphinxjpcommentハッシュタグ： https://twitter.com/hashtag/

sphinxjpcomment「 Sphinx + 翻訳 hack-a-thon 」「 Sphinx Tea

Night 」を毎月開催年に一度の SphinxConJP 開催

わからない事があったら？

twitter のハッシュタグ #sphinxjp で質問するメーリングリストで質問するSlack で質問する

Sphinx ゲットだぜ！

めざせ！ Sphinx マスター！