Download - 忙しい人のためのSphinx 入門 demo
![Page 1: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/1.jpg)
忙しい人のためのSphinx demo
@ t u t u t e n( m o m o _ * )
![Page 2: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/2.jpg)
あんた誰?
Sphinxって何?
インストール手順
reStructuredTextについて
テーマについて
![Page 3: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/3.jpg)
@tututen (momo_*)
道東、北見で働くITエンジニア
C言語とかさわれます
C++とか基礎すっ飛ばしてBoost入門中
パネポンの対戦者募集中です
あんた誰?
![Page 4: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/4.jpg)
北見の場所
札幌←→北見間 294km(高速道路を使用しない)
![Page 5: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/5.jpg)
Sphinxって何?プレーンテキストのファイルから、各種形式のファイルをエクスポートするプログラム
![Page 6: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/6.jpg)
Sphinxって何?拡張機能で、機能を追加していくことができる
ドキュメントは100%日本語化されている
sphinx-user.jp
強力なコードハイライト
利用実績多数!
国内:http://sphinx-users.jp/example.html
国外:http://sphinx.pocoo.org/examples.html
![Page 7: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/7.jpg)
と、ここまで言いましたが
![Page 8: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/8.jpg)
全部受売だったりします
![Page 9: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/9.jpg)
Slideshareで、sphinxで検索すると...
![Page 10: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/10.jpg)
インストール手順Windows
http://sphinx-users.jp/gettingstarted/install_windows_standalone.html
Mac
$ sudo port install python-sphinx
$ brew install sphinx
Ubuntu
$ sudo aptitude install python-sphinx
![Page 11: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/11.jpg)
インストール後コマンドプロンプト、コンソール画面からsphinx-quickstartを実行する
とりあえずはEnter連打!
次の3つだけは回答する
プロジェクト名
バージョン番号
著者名
![Page 12: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/12.jpg)
reStructuredTextreST(reSturucturedText)
http://sphinx-users.jp/doc10/rest.html
テキストでも見やすい形
見出し
コードブロック
文書内/文書外リンク
表
doctreeなどを作成する
![Page 13: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/13.jpg)
インストール後
こっから先は実演を交えて紹介していきたいと思います。
![Page 14: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/14.jpg)
見出し=、-などでデコレーションしたもの
例:==========大見出し==========
中見出し==========
小見出し----------------
![Page 15: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/15.jpg)
リスト先頭に「-」や「#」、「数字」をつける
例:- リスト1- リスト2
7. 数字リスト1#. 数字リスト2
![Page 16: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/16.jpg)
コードブロック.. code-block:: python print ‘hello world’
のように書く
pygmentsが対応している言語であれば、どんな言語もシンタックスハイライトで表示可能
.. literalinclude :: hello.py
のようにファイルを指定することも可能
![Page 17: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/17.jpg)
表-、+、=、-、|で表現した物を表示する
例:(一番複雑なもの)+-------------------------------------------------+|python 札幌 3.14 発表者 |
+===============+================+|name | contents |+-----------------------+-------------------------+|nakayoshix | reading |+------------------------+------------------------+|giginet | django |+------------------------+------------------------+
![Page 18: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/18.jpg)
内部リンク
内部リンクの定義:.. _sample:
内部リンクの参照::ref:`sample` ←見出しの直前に定義が必要:ref:`ほげほげ<sample>`
![Page 19: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/19.jpg)
外部リンク
外部リンクの定義:
`Yahoo! Japan<http://www.google.co.jp>`_
Yahoo! Japan というように表示される。だけど、飛ぶ先はGoogleに飛びます。
![Page 20: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/20.jpg)
画像貼りたい
.. image :: image/path.png :width: 800px
という感じに書きます。
![Page 21: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/21.jpg)
ここまで出来ればドキュメント作成できますね
![Page 22: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/22.jpg)
しかしデフォルトのテーマですと
ちょっとださい物足りないですよね
![Page 23: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/23.jpg)
でも画面デザインとか
面倒臭い!やりたくない!
![Page 24: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/24.jpg)
そんなあなたに朗報です!
![Page 25: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/25.jpg)
外観の変更
自分でテーマを作成
既存のテーマを組み込む
![Page 26: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/26.jpg)
既存のテーマの探し方
Google 先生に聞く
PyPIで探す
デフォルトを使い倒す
![Page 27: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/27.jpg)
閑話休題
![Page 28: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/28.jpg)
PyPIってどう読むの?
「パイピー」?
「パイパイ」?
![Page 29: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/29.jpg)
イアンさんのツイート
https://twitter.com/#!/ianmlewis/status/111953196544557056
![Page 30: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/30.jpg)
PyPIってどう読むの?
公式的には「パイピーアイ」らしいですが、個人的には、「パイピー」を押し貫こうと思います。(キリッ
![Page 31: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/31.jpg)
話を戻しまして
テーマファイルの探し方
PyPIで”sphinx theme”で検索する
![Page 32: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/32.jpg)
検索結果
![Page 33: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/33.jpg)
どんなテーマがあるの?sphinxjp.themes.bizstyle
sphinxjp.themes.sphinxjp
sphinxjp.themes.trstyle
sphinxjp.themes.solarized
cloud_sptheme
z3c.recipe.sphinxdoc
sphinxjp.themes.htmlslide(プレゼン用テーマ)
sphinxjp.themes.s6 (プレゼン用テーマ)
![Page 34: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/34.jpg)
テーマたくさんあるね!
どれも気に入るものがない?
じゃぁ、作ってPyPIに載せちゃおう!
パッケージの作成・配布の仕方は、エキPyの第7章を参考に!
![Page 35: 忙しい人のためのSphinx 入門 demo](https://reader033.vdocuments.pub/reader033/viewer/2022061222/54c209374a795989198b4596/html5/thumbnails/35.jpg)
ご静聴ありがとうございました