django - Django での Sphinx ドキュメント

Question

現在、スフィンクスで生成されたドキュメントを Django アプリに統合しています。アプリ テンプレートを拡張するためのドキュメントが必要です。Sphinx によって生成された HTML は次のようになります。

{% extends "base.html" %}
{% block content %}
...

私のスフィンクスのテーマ テンプレートの外観は次のとおりです。

{{ '{% extends "base.html" %}' }}
{{ '{% block content %}' }}
...

これを達成するためのより良い方法はありますか？

Answer 1

JSONHTMLBuilder を使用します。

https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinxcontrib.serializinghtml.jsonhtmlbuilder

JSON ファイルの内容をページに簡単に挿入できます。

https://www.sphinx-doc.org/en/master/usage/builders/index.html#serialization-builder-details

JSON ドキュメントを読み取り、それをテンプレートにレンダリングします。

def someView( request, topic ):
    # use settings.SOME_DIRECTORY + path info to find the JSON file
    with something as source:
        doc= json.loads( source )
    render_to_response( 'page.template', doc )

それに似たものが機能します。