Question

我正在尝试从我的项目中自动生成python文档。

我的文件夹结构如下：

 .
 my_project/
  |
   pythonfile1.py
   pythonfile2.py
  package1/
    | 
    __init__.py
    datatypes.py
    decorators.py
  package2/
    | 
    __init__.py
    somefile.py
    anotherfile.py
  (...more modules following)

我正在运行

sphinx-apidoc --full --append-syspath -d 10 -o rstfolder /path/to/src

无论其：

index.rst已创建：

Welcome to my_project's documentation!
===================================

.. toctree::
   :maxdepth: 10
   :caption: Contents:

   my_project


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

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

并在my_project.rst

（...文件的开头）

====================

Subpackages
-----------

.. toctree::

    package1.api


Submodules
----------

my_project.pythonfile1
----------------------------

.. automodule:: my_project.accounts
    :members:
    :undoc-members:
    :show-inheritance:


my_project.pythonfile2
----------------------------

.. automodule:: src.accounts
    :members:
    :undoc-members:
    :show-inheritance:

就好像package1中的停止一样，找到.py

以下的所有my_project个文件

有什么建议吗？

编辑：之前的问题指出，潜在的重复被删除了（除了关于不同主题的事实：如何自动生成文档字符串）

自动生成doc时，Python Sphinx会在第一个子包停止

0 个答案: