6

Sphinx を使用して「クラス」リスト/タブを表示する方法、またはクラスごとにメンバーを表示するために生成された html ページを整理し、クラスを視覚的に分離する方法はありますか?

私は Sphinx 1.1.3 を使用して、Python 拡張機能 (Cython で作成されたカスタム拡張機能) を文書化しようとしています。私の問題は、[モジュール] タブに入ると拡張機能全体が 1 つのブロックに表示され (これはまったく判読できません)、一方、[インデックス] タブではすべてがマージされます (これは正常です)。クラスごとの表示が必要です (Doxygen が行うことに近いもの)。

次のようなことをします：

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

* :ref:`classindex`  ???

存在しますか？

どうもありがとう。

4

1 に答える 1

9

構成変数がに設定されたautosummary拡張機能を使用して、1）コンパクトな要約リストを生成し、2）クラスごとに1ページのクラスドキュメントを生成できます。autosummary_generateTrue

含める各クラスを明示的に指定する必要がありますが、これが完了すると、クラスが視覚的に十分に分離されている明確なドキュメントを生成するための設定ができます。

次のマークアップは、クラス（Class1、Class2、Class3）ごとに1つの「スタブ」.rstページを出力します。各ページはテンプレートに基づいており.. autoclass::、完全なドキュメントを抽出するディレクティブが含まれています。最終的なHTML出力では、各クラスページは、メインの自動要約テーブルの対応するエントリからリンクされています。

:mod:`mymodule` --- Some module
===============================

This module contains several classes. 

.. currentmodule:: mymodule

Class overview
--------------

.. autosummary::
   :toctree: stubs
   :template: class.rst

   Class1
   Class2
   Class3

詳細はこちら：https ：//www.sphinx-doc.org/en/master/usage/extensions/autosummary.html

于 2013-01-31T08:54:59.050 に答える