【Sphinx】テーマにHTMLを使って追記する | タナビボ~田中太郎の備忘録~

やりたいこと
方法
まとめ

やりたいこと

HTMLを直接書いて、テーマにちょっとだけ追記したい

方法

source/_templates/page.htmlを作成して下記のように記入します

{% extends "!layout.html" %}

{% block header %}
<!-- いまあるヘッダの上に追記 -->
{{ super() }}
<!-- いまあるヘッダの下に追記 -->
{% endblock header %}

{% block sidebar %}
<!-- 下に追記 -->
{{ super() }}
<!-- 上に追記 -->
{% endblock sidebar %}

{% block body %}
<!-- 上に追記 -->
{{ body }}
<!-- 下に追記 -->
{% endblock body %}

{% block footer %}
<!-- 上に追記 -->
{{ super() }}
<!-- 下に追記 -->
{% endblock %}

あとは通常通り実行すると、page.htmlに追記した内容が反映されます。

page.htmlはデフォルトで_templates/の下に置きますが、conf.pyでディレクトリを変更できます

templates_path = ["_templates"]

まとめ

テーマにちょっとだけ追記しました