在sphinx文档中显示文件夹名称

时间:2018-01-09 06:40:06

标签: python python-sphinx

我在为类生成的.rst文件显示正确的标题时出现问题

我有一个模板class.rst

{{ fullname | underline }}

**Usage:**
*from {{ module }} import {{ objname }}*
.. currentmodule:: {{ module }}
.. autoclass:: {{ objname }}

用于生成autodoc类,例如其中一个是tree.system.cluster.cluster.Cluster.rst,其中包含:

tree.system.cluster.cluster.Cluster
===============================================

**Usage:**
*from tree.system.cluster.cluster import Cluster*
.. currentmodule:: tree.system.cluster.cluster

.. autoclass:: Cluster

目录结构为tree/system/cluster,其中包含cluster.py,而Cluster又包含类cluster/

在目录__init__.py中,from tree.system.cluster.cluster import Cluster包含一行from tree.system.cluster import Cluster。因此,其他文件可以直接使用from tree.system.cluster.cluster import Cluster而不是完整的导入路径。

然而,sphinx文档显示from tree.system.cluster import Cluster。有没有可以帮我显示string relativePathToImage = Path.Combine(Directory.GetCurrentDirectory(), "File", "img.png"); 的方法/标签?我知道完整的导入路径有效,但我希望以实际使用的方式显示。

0 个答案:

没有答案