Sphinx GO!!
Download as PPTX, PDF•0 likes•921 views
2016年7月のささみの会で発表した内容です。 当たりさわりの無い Sphinx についての紹介をしています。
![突然のデモ その２
1. conf.py を書き換える
html_theme = 'bizstyle'
2. make html
3. conf.py を書き換える
extensions = ['sphinxjp.themes.s6']
html_theme = 's6'
4. make html](https://image.slidesharecdn.com/sphinxgoforssmjp-160730041203/85/Sphinx-GO-5-320.jpg)
Sphinx GO!!
- 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
- 4. 突然のデモ その１ 1. sphinx-quickstart 2. 記述済みのテキストファイルをコピーする 3. make html 4. Webブラウザで表示する
- 5. 突然のデモ その２ 1. conf.py を書き換える html_theme = 'bizstyle' 2. make html 3. conf.py を書き換える extensions = ['sphinxjp.themes.s6'] html_theme = 's6' 4. make html
- 8. reST(reStructuredText) reST は Python が生み出した軽量 マークアップ言語 可読性が高い 表現力が高い 表 箇条書き 図の表示
- 9. Markdown 制約がありますが Markdown も使 えます。 Sphinx のディレクティブ（命令）が使えない
- 10. Sphinx の特長 プレーテキスト 開発者がプログラムのソースコード を扱うのと全く同じ環境、道具(エ ディタ、バージョン管理ツール、CI) を利用する事ができる。 バージョン管理しやすい 複数人で編集しやすい！ 文書の分割、結合が楽
- 11. エディタの注意 文字コードを UTF-8 にする ハードタブは使わない 等幅フォントを使う reST の syntax ハイライトを探す
- 14. Sphinxの特長 ドキュメントの記述に集中できる 出力した時の見た目（体裁）と内容が分離し ている為、慣れればドキュメントの記述に集中す る事ができる。 reST や Sphinx の記述に慣れる必要はある
- 15. Sphinxの特長 拡張性 有志が作成したさまざまな拡張がある テーマ Blockdiag 拡張を自身で作成する事も可能(Python) ホスティングサービス「Read the Docs」
- 16. Sphinx のホスティングサービス https://readthedocs.org/ Github や Bitbucket のリポジトリを参照してドキュメントを公開する事ができるサービス
- 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. わからない事があったら？ twitter のハッシュタグ #sphinxjp で質問する メーリングリストで質問する Slack で質問する