Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Sphinx GO!!

496 views

Published on

2016年7月のささみの会で発表した内容です。
当たりさわりの無い Sphinx についての紹介をしています。

Published in: Technology
  • Be the first to comment

  • Be the first to like this

Sphinx GO!!

  1. 1. Sphinx-users.jp 山田剛 #ssmjp 2016/07/29
  2. 2. おまえ誰よ 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
  3. 3. Sphinx-Users.JP 「Sphinx」というPythonのドキュメンテーション ツールのユーザ会で活動しています。 3 現在、@togakushiさん他、 ユーザ会のメンバで SoftwareDesignにSphinx の記事を連載中!
  4. 4. 突然のデモ その1 1. sphinx-quickstart 2. 記述済みのテキストファイルをコピーする 3. make html 4. Webブラウザで表示する
  5. 5. 突然のデモ その2 1. conf.py を書き換える  html_theme = 'bizstyle' 2. make html 3. conf.py を書き換える  extensions = ['sphinxjp.themes.s6']  html_theme = 's6' 4. make html
  6. 6. Sphinx とは reStructuredText をメインに記述した プレーンテキストをインプットし、 様々なフォーマットをアウトプットする ドキュメンテーションジェネレータです
  7. 7. マルチインプット、マルチアウトプット インプット Sphinx アウトプット reST Markdown jpeg,png... Excel html PowerPoint HTML man PDF ePub3 LaTeX text csv gettext json
  8. 8. reST(reStructuredText) reST は Python が生み出した軽量 マークアップ言語 可読性が高い 表現力が高い  表  箇条書き  図の表示
  9. 9. Markdown 制約がありますが Markdown も使 えます。  Sphinx のディレクティブ(命令)が使えない
  10. 10. Sphinx の特長 プレーテキスト 開発者がプログラムのソースコード を扱うのと全く同じ環境、道具(エ ディタ、バージョン管理ツール、CI) を利用する事ができる。 バージョン管理しやすい  複数人で編集しやすい! 文書の分割、結合が楽
  11. 11. エディタの注意 文字コードを UTF-8 にする ハードタブは使わない 等幅フォントを使う reST の syntax ハイライトを探す
  12. 12. Sphinxの特長 構造化 階層構造を促され、文書作成が横道にそれにく い toctree 箇条書き セクション
  13. 13. Sphinxの特長 目的の情報へ到達しやすい 目的の情報への導線が豊富 インデックス クロスリファレンス 標準の検索窓
  14. 14. Sphinxの特長 ドキュメントの記述に集中できる 出力した時の見た目(体裁)と内容が分離し ている為、慣れればドキュメントの記述に集中す る事ができる。  reST や Sphinx の記述に慣れる必要はある
  15. 15. Sphinxの特長 拡張性 有志が作成したさまざまな拡張がある テーマ Blockdiag 拡張を自身で作成する事も可能(Python) ホスティングサービス「Read the Docs」
  16. 16. Sphinx のホスティングサービス https://readthedocs.org/ Github や Bitbucket のリポジトリを参照してドキュメントを公開する事ができるサービス
  17. 17. ユーザ会の活動  ユーザ会サイト:http://sphinx-users.jp/comment  Slack https://sphinxjp.herokuapp.com/  メーリングリスト登録: http://www.python.jp/mailman/listinfo/sphinx- userscomment  イベント告知: http://sphinxjp.connpass.com/comment  Twitterアカウント: https://twitter.com/sphinxjpcomment  ハッシュタグ: https://twitter.com/hashtag/sphinxjpcomment  「Sphinx + 翻訳 hack-a-thon」「Sphinx Tea Night」 を毎月開催  年に一度の SphinxConJP 開催
  18. 18. わからない事があったら?  twitter のハッシュタグ #sphinxjp で質問する  メーリングリストで質問する  Slack で質問する
  19. 19. Sphinx ゲットだぜ! めざせ! Sphinx マスター!

×