4

関数、クラスなどを一覧表示して、Sphinx の目次に表示するにはどうすればよいですか?

または、より一般的には、ページ内の任意のエントリ (字幕ではない) を目次に追加するにはどうすればよいですか?

ところで: 私は Python コードを文書化していないので、autodoc ツールは使用できません。

編集

私はディレクティブを試しました.. contents:: nameが、それはエントリを定義するためではなく、ToC を配置するためのようです。

編集：部分的な解決策

basic/localtoc.htmlテンプレートを_templatesディレクトリにコピーしました。

{{ pagename }}現在のファイルへのパスを提供し、ファイルを{% include filename %}含めることができるので、おそらくそれらを組み合わせて、実行するたびにすべてのファイルに対して独自の目次を生成することができますconf.py. これを試してみますが、もっと自動的な解決策はありますか?

4

2 に答える 2

0

個々のテンプレートを多数作成する代わりに、javascript を使用して読み込み時に目次の追加エントリを入力する 1 つのテンプレートを作成できます。

、、およびのリストを動的に生成するsphinx docs の automodule によって生成されたすべてのクラスで、 Toc/listの viblo のスクリプトを使用できます。ClassesFunctionsVariables

私は次の_templates/localtoc.htmlようになります。

<h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
{%- if display_toc %}

  {{ toc }}
{%- endif %}
<div class="custom-index container">
<script type="text/javascript" src={{ pathto(master_doc)[:-10] + '_static/pymunk.js' }}></script>

</div>
于 2013-01-19T06:09:48.880 に答える