如何在sphinx文档中自动添加参数类型
我目前正在尝试使用Sphinx（使用扩展程序sphinx-apidoc和napoleon）实现自动文档创建。这个方法非常有效，但如果能够自动添加参数列表中的类型提示（PEP484约定），那就更好了。 我想知道这是否可能。 更具体地说： （来自napoleon示例）def function_...
我应该如何使用Numpy的风格记录类和对象属性？
我一直在阅读Numpy的文档标准，但它似乎没有提到对象属性 - 只有类属性。 那么，例如，我该如何记录以下内容呢？class ClassA(object): """Short description of ClassA Long description of ClassA ...
Sphinx Napoleon扩展：使用Google风格的文档字符串记录多个返回参数
这个问题与另一个问题有关。所提出和接受的解决方案是： Returns: (tuple): tuple containing: arg1: First Argument ...
使用类型注释记录类属性
我希望能够从文档字符串自动生成我的代码文档。我有一些基本的类用于存储一些数据：class DataHolder: """ Class to hold some data Attributes: batch: Run without GUI ...
谷歌风格的文档字符串示例部分未呈现为代码片段。
我最近开始为我的项目添加文档，并尝试遵循Google风格指南。我正在使用Sphinx生成文档，并使用Sphinx扩展napoleon来弥补Google风格指南和reST之间的差距。 我可以轻松地呈现params和Notes，但是似乎无法使示例部分呈现代码片段。 class Chicken(...
如何使用Google风格的Sphinx文档化列表、可选项和yield？
如何使用Sphinx-Napoleon在Google风格文档字符串中指定列表、可选参数和生成器的返回类型？ 我已经尝试过：List[type] list of type Optional[type] type, optional 和Yields: type: 但是所有这些方法都会产...
“autodoc_default_flags”在Python Sphinx配置中是如何工作的？
我正在尝试使用Sphinx 1.4和sphinx-apidoc以及sphinx.ext.autodoc扩展来为我的Python类生成文档。 我有很多模块，我希望每个模块只显示类名，而不是类中所有方法的完整列表（这些方法在我的代码中都有docstrings）。 以下是我的conf.py文件的...
自定义 PyCharm 文档字符串存根（例如用于 Google Docstring 或 Numpydoc 格式）。
PyCharm 2.7（或PyCharm 3）是否支持自定义docstring和doctest stubs？如果是，如何编写此特定类型的自定义扩展？ 我的当前项目已经标准化使用Google Python Style Guide（http://google-styleguide.googlec...
Sphinx自动摘要中“toctree包含对不存在文档的引用”的警告
我正在尝试使用Sphinx自动为一个大型Python代码库创建API文档。 我已经尝试过使用build_modules.py和sphinx-apidoc。使用其中任何一种工具，我都能够成功地在我的输出目录中创建rst文档，用于包和顶级模块。 但是，当我使用以下命令构建时：make html...
将Python文档字符串从reStructured Text转换为Google风格的简单方法？
有人知道将现有项目中的所有文档字符串从reStructured Text转换为Google格式的简单方法吗？ 似乎Napoleon可以做到这样的事情，但看起来非常复杂，所以我想问问是否有人之前做过。任何想法都将不胜感激。