Sphinx customized theme

官網說明有完整說明, 這裡記個人速記版。

找出 default theme 位置並複制一份出來, 供之後修改:

# 找出 default theme 的位置
$ locate default/static
/usr/lib/python2.5/site-packages/Sphinx-1.0.7-py2.5.egg/sphinx/themes/default/static
/usr/lib/python2.5/site-packages/Sphinx-1.0.7-py2.5.egg/sphinx/themes/default/static/default.css_t
/usr/lib/python2.5/site-packages/Sphinx-1.0.7-py2.5.egg/sphinx/themes/default/static/sidebar.js

# 切到自己建的 Sphinx 目錄
$ cd docs

# 複制 default theme 出來
$ cp -r /usr/lib/python2.5/site-packages/Sphinx-1.0.7-py2.5.egg/sphinx/themes/default MY_THEME  

編輯 conf.py 加入:

html_theme = 'MY_THEME'
...
html_theme_path = ['.']

這樣之後改 MY_THEME 下的東西即可。

若只需要改 css 的話, 不需複製整個 theme 出來, 可以改 conf.py 裡的 html_static_path, 改用自己的 default.css 覆蓋 default theme 用的 css。照上面的方式找到 default theme 用的 css, 複制出來放到 _static/default.css, 之後再修改這個檔案即可。

留言

這個網誌中的熱門文章

virtualbox 使用 USB 裝置

熟悉系統工具好處多多

如何 git merge 更改檔名的檔案