バックグラウンド
Sphinxで文書化されているciscoconfparseというプロジェクトがあります。プロジェクトのドキュメントはこちらです。
ソース コード ディレクトリには複数のファイルがあります。
ciscoconfparse.pyクラスCiscoConfParseとIOSConfigListmodels_cisco.pyと呼ばれるクラスを含むIOSCfgLine
これは、私がどのように文書化しているかの例ですIOSCfgLine...
.. module:: models_cisco
IOSCfgLine Object
-----------------
.. autoclass:: IOSCfgLine
:members:
:inherited-members:
既存の Sphinx ドキュメントには、ファイル名とクラス名の両方を含む、見苦しいクラス ハイパーリンクがあります。一例ですmodels_cisco.IOSCfgLine。
ドキュメントのスクリーンショットの例:
質問
クラスに含まれるファイル名ではなく、レンダリングされたドキュメントでクラス名のみautoclassを表示し、さまざまな Python ファイルでクラスをドキュメント化するにはどうすればよいですか? つまり、 の代わりにへのハイパーリンクを表示したいだけです。IOSCfgLinemodels_cisco.IOSCfgLine