Sphinx - 如何自动记录子文件夹和模块

时间:2017-06-07 18:12:31

标签: python python-sphinx

我有以下文件夹结构:

folder_1
    - folder_1.1
    - folder_1.2
        - folder_1.2.1
    ... etc

在每个folder_N.n.m中都有一个__init__.py,并且已在每个文件夹中运行sphinx-quickstart

index.rst中的folder_1如下所示:

.. My Library documentation master file, created by
   sphinx-quickstart on Wed Jun 07 13:24:49 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to My Library's documentation!
=======================================

Contents:

.. toctree::
   :maxdepth: 5

.. automodule:: folder_1.1
   :members:

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

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

但是当我转到我的index.html或该文件中的索引时,我只看到模块名称folder_1,但我没有看到任何子模块完全记录。

每个文件都包含许多函数,每个函数都有一个格式正确的文档字符串。

我希望为index.html创建的folder_1也包含所有子文件夹,模块和函数的文档。

0 个答案:

没有答案