Sphinxドキュメントにトラッキングコードを追加する

Posted: , Modified:   Sphinx Qiita

本稿は Qiita 投稿記事 のバックアップです.

概要

sphinx_rtd_theme を使ったSphinx ドキュメントにトラッキングコードを追加する方法の備忘録.

方法

sphinx_rtd_theme の layout.htmlにある,extrabody ブロックを使う.

作成中ドキュメントの _template ディレクトリに次のような内容の layout.html を作成する.

{% extends "!layout.html" %}

{% block extrabody %}
  <script>
    トラッキングコードを埋め込むスクリプト
  </script>
{% endblock %}

{% extends "!layout.html" %} で sphinx_rtd_theme の layout.html を拡張することを宣言し,extrabody の内容を定義している.

後はコンパイルすれば良い.

参考