PyCharm 2.7（或PyCharm 3）是否支持自定义docstring和doctest stubs？如果是，如何编写此特定类型的自定义扩展？ 我的当前项目已经标准化使用Google Python Style Guide（http://google-styleguide.googlec...

有时Python中的函数可能会接受可变类型的参数，或者返回可变类型的值。我现在无法想起这样一个函数的好例子，因此我将通过下面的玩具示例来演示这样一个函数的样子。 我想知道如何使用Sphinx文档符号为这样的函数编写docstring。在下面的示例中，参数可以是str或int。同样，它也可以返...

我正在尝试使用Sphinx自动为一个大型Python代码库创建API文档。 我已经尝试过使用build_modules.py和sphinx-apidoc。使用其中任何一种工具，我都能够成功地在我的输出目录中创建rst文档，用于包和顶级模块。 但是，当我使用以下命令构建时：make html...

如何使用Sphinx-Napoleon在Google风格文档字符串中指定列表、可选参数和生成器的返回类型？ 我已经尝试过：List[type] list of type Optional[type] type, optional 和Yields: type: 但是所有这些方法都会产...

我希望能够从文档字符串自动生成我的代码文档。我有一些基本的类用于存储一些数据：class DataHolder: """ Class to hold some data Attributes: batch: Run without GUI ...

我正在尝试使用Google代码风格来记录一个函数，然后使用sphinx和napoleon扩展创建文档。该函数返回两个参数，这在使用napoleon时可能会出现问题。如果可以，请问有人知道如何处理这种情况吗？def foo(a): '''one line summary longer expl...

我正在使用Sphinx来记录一个Python项目。我想在我的docstrings中使用Markdown格式。 即使我使用了recommonmark扩展，它仅覆盖手动编写的.md文件，而不是docstrings。 我在扩展中使用了autodoc、napoleon和recommonmark。 ...

有人知道将现有项目中的所有文档字符串从reStructured Text转换为Google格式的简单方法吗？ 似乎Napoleon可以做到这样的事情，但看起来非常复杂，所以我想问问是否有人之前做过。任何想法都将不胜感激。

我一直在阅读Numpy的文档标准，但它似乎没有提到对象属性 - 只有类属性。 那么，例如，我该如何记录以下内容呢？class ClassA(object): """Short description of ClassA Long description of ClassA ...

我正在使用Numpy风格的文档字符串为Python项目编写文档。 numpydoc 和 napoleon 是两个Sphinx扩展，用于解析Numpy风格的文档字符串以生成文档。第一个扩展被用于Numpy项目本身，而第二个扩展则随Sphinx一起发布。 使用其中一个扩展有哪些优缺点？