Sphinxのカスタマイズについて

Sphinxは、CSSのテンプレートに従って、HTMLを装飾する．

custom.cssの準備

• CSSテンプレート、 custom.css を "source/_static/" 以下に作成する．

• ここにカスタムテンプレートを作成、追記していく．

• conf.py に以下を追記して、読み込み設定する

html_static_path = ['_static']
html_css_files = [custom.css]

ロールの追加

独自のロール（文中で装飾をつける機能）が設定できる．

これを使えば、赤文字やフォント変更などが作れる．

1. "." (ドット) + "ロール名"でCSSクラスを定義する．

2. conf.py の中のroles（リスト）に、ロールの名前を追記する．( "." (ドット)以下の名前 )

(e.g.1) CSSの記載例

.ricty {
  font-family: "Ricty", monospace;
}
.strike {
  text-decoration: line-through;
}
.red {
  color: red;
}
.blue {
  color: blue;
}

(e.g.2) conf.py中のrolesの記載例

roles = ['strike', 'red', 'blue', 'ricty']

custom.cssの記載例 (フォントの変更)

例えば、

cite, code, tt {
  font-family: "Ricty";
}

pre {
  font-family: "Ricty";
}

によって、リテラルブロック内のフォントを変更できる． 使用可能なフォント名については、:

$ fc-list | grep -i xxxx

などで調べられる．