テンプレートを作成する

出力されるドキュメントのひな型としてHTMLのテンプレートを作成します。Sphinxでは、デフォルトのHTMLテンプレートとしてJinjaが使用されます。

必要となるテンプレート

オリジナルのテーマを作成する際に、最低限必要なテンプレートは次のテンプレートです。

  • ドキュメント全体の基礎となるテンプレート
  • 基礎となるテンプレートを基にドキュメントを表示するテンプレート

以降の例では、前者のテンプレートをlayout.html、後者のテンプレートをpage.htmlとします。

Sphinxでは、作成したドキュメント(.rstのファイル)の他に、検索ページ(search.html)や、索引ページ(genindex.html)も生成されます。次の様にtheme.confで継承元を指定しない場合には、生成される全てのページに対してのテンプレートが必要になります。

theme.confで、以下の様に継承元のテーマを指定すれば、実際に全てのドキュメントに対してテンプレートを作成する必要はありません。オリジナルテーマで用意していないテンプレートの代わりに継承元のbasicテーマで用意されているテンプレートが適用されます。

inherit = basic

ドキュメントの枠組みを作成する

テーマディレクトリ内にlayout.htmlを作成し、基本となる枠組みを作成します。Jinjaの記法については、公式のドキュメントを参照してください。

layout.htmlには、全ページ共通のヘッダー、サイドバー、ドキュメント部、フッターを記述します。

{%- block doctype %}
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3c.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
{%- endblock doctype %}
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  <title>{{ title }}</title>
  <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
</head>
<body>
<div id="wrapper">
{%- block header %}
  <div id="header">
    <h1>header</h1>
  </div>
{%- endblock header %}
{%- block sidebar %}
  <div id="sidebar">
    <h2>sidebar</h2>
  </div>
{%- endblock sidebar %}
{%- block document %}
  <div id="document">
    <h2>document</h2>
    {%- block body %}{%- endblock body %}
  </div>
{%- endblock document %}
</div>
{%- block footer %}
<div id="footer">
  <h1>footer</h1>
</div>
{%- endblock footer %}
</body>
</html>

次に、各ページのドキュメント内容を読み込むpage.htmlを作成し、各ドキュメントの内容を読み込みます。

{% extends "!layout.html" %}
{% block body %}
{{ body }}
{% endblock body %}

page.htmlでは、{% extends "!layout.html" %}の様にlayout.htmlを継承します。テンプレートの継承についてはテンプレートを継承するを参照して下さい。

一旦、ドキュメントの出力内容を確認するために、以下のスタイルシートを適用しました。

main.css

#header {
  background-color: #a2e8fe;
}

#sidebar {
  background-color: #4b7afd;
  float: left;
  width: 20%;
}

#document {
  background-color: #f7fed3;
  float:left;
  width: 80%;
}

#footer {
  background-color: #fcc1c1;
  clear: both;
}

h1 {
  margin: 0;
}

このmain.cssは、テーマディレクトリ内のstaticディレクトリ内に配置します。

ここで、make htmlコマンドでドキュメントを生成すれば、オリジナルのテーマを適用したドキュメントは以下の様になります。

../../_images/layout01.jpg

テンプレートを継承する

現在のところ、以下のパーツから成るドキュメントのテンプレートを作成しています。

  • header
  • sidebar
  • document
  • footer

このドキュメントに足りていないサイドバー内のパーツ、リレーションバーを作成します。以下のスクリーンショットは」basic」テーマを適用した際の各バーツです。

../../_images/layout02.jpg

実際のところ、上記のパーツを1から作る必要はありません。ここでは、」basic」テーマのlayout.htmlを継承して、各パーツをオリジナルのテーマに組込みます。

「basic」テーマのテンプレートを継承する場合は、テンプレートの先頭に以下の1行を記述します。

{% extends "継承元のテーマ名/継承するテンプレート" %}

継承元のテーマ名を省略した場合は、同テーマ内のテンプレートを継承します。

他のテンプレートを継承した場合、オリジナルテーマのlayout.htmlに記述するべきパーツは、継承元のテンプレートとの差異になる部分だけです。以下のlayout.htmlでは、」basic」テーマのlayout.htmlを継承して、新たにオリジナルのヘッダを追加しています。

layout.html

{% extends "basic/layout.html" %}
{%- block header %}
<div id="header">
    <p>オリジナルヘッダ</p>
</div>
{%- endblock header %}
../../_images/layout03.jpg

追加したヘッダ以外は、」basic」テーマのテンプレートが適用されるため、サイドバー内の目次や検索ボックス、リレーションバーが生成されています。

また、継承元のテンプレートで用意されているバーツに、さらにオリジナルテーマのパーツを加えたい場合があります。

以下の例では、」basic」テーマのリレーションバーに、外部サイトへのリンクを追加します。

{% extends "basic/layout.html" %}
{% block header %}
<div id="header">
    <p>オリジナルのヘッダ</p>
</div>
{% endblock header %}
{% block relbar1 %}
<a href="http://projecthome.com/">Project Homepage</a>
{{ super() }}
{% endblock relbar1 %}

relbar1ブロックを定義する際に、{{ super() }}と記述している事に注意してください。

{{ super() }}は、継承元のテンプレートで定義されている内容を維持したい場合に記述します。記述しない場合には、継承元のブロックを上書きするため、継承元の内容は表示されません。

テンプレートを継承する方法として、以下のように」!」を記述する方法もあります。

{% extends "!layout.html" %}

「!」を継承するテンプレート名につける事で、ユーザが用意したテンプレートを継承元として参照する事になります。

ユーザが用意したテンプレートとは、」conf.py」のtemplates_pathで設定されているパスに配置されているものです。ドキュメントに使用されるテンプレートは以下の順番で探索されます。

  • template_pathで指定されたディレクトリ内のテンプレート
  • 選択されたテーマ内のテンプレート
  • テーマが継承しているテンプレート

「basic」テーマでは、Sphinxで作成されたドキュメントの基本になるテンプレートが提供されています。」basic」テーマに組み込まれているパーツ(ブロック)や組込の関数、変数を利用する事で、さらに細かいオリジナルテーマを作成する事ができます。

「basic」テーマに組み込まれているパーツ(ブロック)や関数については、Sphinxドキュメントの組み込みテンプレートの働きを参照してください。

オプションを設定する

theme.confにoptionsセクションを用意することで、テーマを使用するユーザが簡単にテーマをカスタマイズすることが出来る様になります。

まず、option.css_tの様な_tで終わる名前のCSSファイルを用意します。このファイルを静的テンプレートと言います。カスタマイズ不要な項目については、別のCSSファイルに記述しておき、静的テンプレート側でインポートする様にします。

静的テンプレートでは、以下の様にプロパティの値として変数を設定し、theme.confのoptionsセクションには、変数 = デフォルト値という形式で、ユーザが変更出来る項目を指定します。

theme.conf

[theme]
inherit = basic
stylesheet = option.css
pygments_style = sphinx

[options]
linkcolor     = blue
headerbgcolor = #FFFFFF

注釈

theme.confのstylesheetには、静的テンプレートを_tを抜いた名前で指定します。

設定したオプションにアクセスするには、theme_変数名の形式で記述します。

option.css_t

@import "main.css";

a:link {
    color: {{ theme_linkcolor }};
}

#header {
    background-color: {{ theme_headerbgcolor }}
}

theme.confの設定値はデフォルト値なので、オプションをユーザ側の設定で利用するにはconf.pyhtml_theme_optionsの値をPythonの辞書形式で設定します。

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
html_theme_options = {
  'linkcolor': 'red',
  'headerbgcolor': 'blue'
}

オプションはCSSの指定だけではなく、HTMLテンプレート内で使用する変数としても利用することができます。例としてグローバルメニューを作ってみましょう。事前に、新たなソースファイル(.rstファイル)として以下のファイルを作成しました。

  • about.rst
  • introduction.rst
  • contact.rst

conf.pyhtml_theme_optionsの値を以下の様に、』タイトル』:』ソースファイル』という形でナビゲーションの要素を設定し、layout.htmlでオプションとして設定したナビゲーション要素を取出します。

conf.py

html_theme_options = {
  'navigation': [
    ('About', 'about'),
    ('Intro', 'introduction'),
    ('Contact', 'contact')
  ]
}

layout.html

{% extends "basic/layout.html" %}
{% block header %}
<div id="header">
  <h1><a href="{{ pathto('index') }}">{{ project }}</a></h1>
  <div id="nav">
    <ul>
      {%- for title, href in theme_navigation %}
      <li><a href="{{ pathto(href) }}">{{ title }}</a></li>
      {%- endfor %}
    </ul>
  </div>
</div>
{{ super() }}
{% endblock header %}

ここまでで、基本的なレイアウトの作成ができました。次はスタイルシートを適用するに進んでください。