0

我有一个示例项目:

docs/
src/
----| model/
------------| first.py
------------| second.py
----| utils
------------| some_helper.py
------------| some_organizer.py
----| io
------------| read_data.py
------------| dataset/
---------------------| lazy_dataset.py
---------------------| in_mem_dataset.py

当我使用sphinx-apidoc它时,它会生成非常难看的标题,如下所示:src.some_package.some_subpackge.some_module. 我想要做的是不要在生成的 ToC 中重复前面的标题。生成这样的东西:

src.some_package
   - src.some_package.some_subpackage
          - src.some_package.some_subpackage.some_module

像这样的东西是我的偏好:

some_package
   - some_subpackage
          - some_module

我曾尝试使用此处描述的方式生成 api-doc,但我没有运气。

目前我使用生成狮身人面像项目:sphinx-quickstart然后将其附加到makefile:

buildapi:
    sphinx-apidoc -fMeET ../src -o api
    @echo "Auto-generation of api documentation finished. " \
          "The generated files are in 'api/'"

并插入一个api.rstindocs/文件夹。该文件的内容是:

API Documentation
=================

Information on specific functions, classes, and methods.

.. toctree::
   :glob:

   api/*
4

0 回答 0