问题描述 投票:0回答:5
这是我的文件层次结构。

InfoRescue docconf.py "檔案,在 "import sys, os "之後加上一行,例如:"InfoRescue docconf.py"。

当然,如果你把docstrings同时放到 "utils__init__.py "和 "includes__init__.py "中,并试图用Sphinx把这两个文件都加上这些路径,那么你将不得不做更多的工作。 自动总结生成一个表您可能更希望使用类似

自动化模块doc 在你的.rst文件中。

.. InfoRescue documentation master file, created by
   sphinx-quickstart on Sun Sep 15 13:52:12 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to InfoRescue's documentation!
======================================

Contents:
========

.. toctree::
   :maxdepth: 2

   project
   api/api
   contact

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

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

改进了上面@BarryPie的回答,并且有这样的问题,即必须添加所有的... ...

InfoRescue API
**********

.. toctree::
    :glob:
    :maxdepth: 1

    **

的所有子包,我在我的 .. autofunction:: utils.u1.functionName :并按要求导入所有子包。

python-sphinx restructuredtext autodoc
5个回答
© www.soinside.com 2019 - 2024. All rights reserved.