Sphinx apidoc-不要打印包和模块的完整路径

问题描述

我对Shinx非常陌生，我正在尝试将其用作我的项目的API参考。也许在那之后也可以作为项目文档。

我使用这两个命令生成它

sphinx-apidoc -e -o doc/api tracer
sphinx-build -b dirhtml doc/ build/doc/dirhtml

生成此目录时出现问题

- tracer package
    - tracer.lang package
        - tracer.lang.en module
    - tracer.packageManagers package
        - tracer.packageManagers.dnf module
        - tracer.packageManagers.dpkg module
        - tracer.packageManagers.portage module
        - ...
    - tracer.resources package
        - tracer.resources.ProcessesList module
        - tracer.resources.applications module
        - tracer.resources.args_parser module
        - ...

不必要的冗余信息的列表原因非常不清楚。这样会好得多：

- tracer package
    - lang package
        - en module
    - packageManagers package
        - dnf module
        - dpkg module
        - portage module
        - ...
    - resources package
        - ProcessesList module
        - applications module
        - args_parser module
        - ...

或者更好，末尾没有package或module标签。

不管怎么说，它看起来都不太好。例如

class tracer.packageManagers.portage.Portage
    Bases: tracer.packageManagers.ipackageManager.IPackageManager

会比

好得多

class Portage
    Bases: IPackageManager

我知道在模块名称可以相同的大项目中，全名可能会很好，但我不喜欢在我的小项目中使用全名。我可以以某种方式告诉apidoc生成缩写名称吗？

你能帮帮我吗？

非常感谢您，Frostyle X

推荐答案

就目录而言，在源文件夹中对所有*.rst文件执行搜索/替换操作(在运行sphinx-apidoc之后)是我最终成功的方法。

搜索：

^(?:[a-zA-Z0-9]*[.])*([a-zA-Z0-9]+) (package|module)

替换：

1 2

...这将缩短标题，即显示在目录树中的标题。唯一的结果是该模块页面上的标题也将是短名称，但这并不影响我，因为导航和目录仍然清楚地表明父包是什么。

根据类/函数名，mzjin对问题的评论：

应该能起作用。

这篇关于Sphinx apidoc-不要打印包和模块的完整路径的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持！