Yumでも導入できるが、そちらはバージョンが古いので "pip" での導入を薦める。生成されるドキュメントの見た目はテーマで好きに変えられる。自分は "sphinx-bootstrap-theme" を利用している。
$ sudo yum groupinstall development-tools
$ sudo yum install python-setuptools python-pip python-devel
$ sudo pip install sphinx sphinx-bootstrap-theme
ドキュメントのベースとなるディレクトリを作成
QuickStartで初期設定を行う:
$ mkdir example && cd $_
$ sphinx-quickstart
あとは "reStructuredText入門" などを参照しドキュメントを作成、各形式に出力するだけ(楽!)
自分の好みに合わせて少しだけ変更を加えた
見出し(h1,h2..)のフォントサイズを変えたかったので "bootstrap-sphinx.css_t" の table の下あたりに、フォントサイズの指定を加えた。
/*
* custom fontsize
*/
h1 { font-size: 1.3em }
h2 { font-size: 1.2em }
h3 { font-size: 1.125em }
h4 { font-size: 1em }
h5 { font-size: 0.75em }
h6 { font-size: 0.625em }
"layout.html" の93行目のmetaタグの下にトラッキングコードを追記
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<!-- Google Analytics : Start -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61257604-1', 'auto');
ga('send', 'pageview');
</script>
<!-- Google Analytics : End -->
{% endblock %}
$ pip install recommonmark
$ vi conf.py
from recommonmark.parser import CommonMarkParser
source_parsers = {'.md': CommonMarkParser}
source_suffix = ['.rst', '.md']
こんだけ。
コードサンプルの表示
ハイライト可能な言語については http://pygments.org/docs/lexers/ を参照
ドメインを指定する事で作成されるドキュメントを特定の言語へ向けたものに特化する(デフォルト値はPython(py))