在Pycharm中获取Sphinx以在生成的html中包含我的docstrings

Question

我有一个运行3.7.2 Python解释器的Pycharm项目，我配置了Sphinx来生成文档。我的项目有以下结构：

/my_project/
  /docs/
  /src/
    /modules/
    /tools/

模块和工具中都有python模块，这些模块都记录在文档字符串中。我已经将Sphinx配置为在/ docs中生成文档，但是本文档只有一个基本的index.rst。如何从我的文档字符串中获取python模块文档以填充到/ docs文件夹中？

Answer 1

也许你可以尝试以下方法：

1. 确保您尝试记录的模块具有__init__.py文件，以便稍后可以根据需要导入它们。在您的情况下，您的tools和modules目录需要__init__.py文件。
2. 确保您正在记录的所有模块都已使用正确的sphinx注释进行设置：

module_1.朋友:

"""
.. module:: module_1
   :platform: Unix, Windows
   :synopsis: A useful module indeed.
"""

def public_fn_with_sphinxy_docstring(name, state=None):
    """This function does something.

    :param name: The name to use.
    :type name: str.
    :param state: Current state to be in.
    :type state: bool.
    :returns:  int -- the return code.
    :raises: AttributeError, KeyError

    """
    return 0

3. 创建一个新的.rst文件，可能称为code.rst，其中包含您要记录的模块。然后在你的.rst中引用这个新的index.rst文件：

code.rst：

Documentation for the Code
**************************

.. automodule:: an_example_pypi_project


module #1 -- auto members
=========================

This is something I want to say that is not in the docstring.

.. automodule:: an_example_pypi_project.module_1
   :members:

index.rst：

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   # other rst files you're including in your sphinx docs

   code.rst

这是一个非常好的解释和tutorial，如果你想检查这一点。希望这有帮助！