回答情况：
提问时间：
问题标签：
在我的conf.py中，我有：在我的doc文件中，我有：extensions = ['sphinx.ext.autodoc', 'numpydoc', 'sphinx.ext.autosummary我得到了：
WARNING: toctree r
浏览 19修改于2020-01-21得票数 23
注意:我终于让numpydoc工作了。这也是python 2的一个问题。我对它进行了2到3次测试，现在它似乎正在工作。狮身人面像广告中那样工作，但我想使用NumPy风格的文档，所以我想安装numpydoc。如果重要的话，我使用Python3.3( windows 7上的winpython 64位)。我从的方向开始，但得到了错误：Could not import extension numpydoc (exception: cannot import name setup)
我在谷歌上发现，有些人是通过使用
浏览 6修改于2020-01-21得票数 4
是否可以在使用时禁用完整的？.. autoclass:: my_module.MyClass :show-inheritance:
my_method..autosummary::块完全符合我的要求，但是..autoclass::会自动创建一个完整的方法表。有办法禁用此功能吗？
直接使用
浏览 2修改于2020-01-22得票数 1
回答已采纳
在开始将其作为docutils或numpydoc的扩展实现之前，这是一个侦测问题。我是错过了一个现有的解决方案，还是存在一个优雅的解决方案？
浏览 13修改于2020-01-24得票数 3
在list文档字符串中键入 of int的正确方法是什么。def my_function(numbers): Parameters numbers : int[] """
浏览 4修改于2020-01-23得票数 3
回答已采纳
我正在使用NumPyDoc样式的文档字符串来记录一个Python包。我想从 Sphinx扩展切换到，因为我发现它以更紧凑和可读性更强的方式格式化了文档字符串。但是，它没有在文档的顶部列出类的方法，这是numpydoc的一个非常有价值的特性。有人知道如何在拿破仑中手动打开它吗？
浏览 18修改于2017-01-20得票数 10
我正在管理一个使用NumpyDoc样式的包，并试图正确地记录一些属性的setters/getter。
特别是，我认为python忽略了setter的文档，因此所有文档都必须进入getter。是否有一种标准的方法可以很好地处理NumpyDoc以及各种文档解析器(例如狮身人面像)？
浏览 3提问于2018-02-19得票数 3
回答已采纳
根据中的惯例，应以下列方式记录函数参数： """" This function does nothing
---------- Description of parameter `x`. pass现在，我希望参数是BaseClass的实例或任何公开相同接口的对象(例如从BaseClass派生的类)。是否有一种惯例，即如何简明地记录参数x
浏览 2修改于2020-10-06得票数 3
我正在使用Spyder (在Mac上使用2.1.11版本)并编写一些代码，在为函数编写DocString (NumpyDoc格式)时，我无法理解为什么Spyder对象检查器以这种奇怪的方式格式化缩进行。如何使用(或不使用)缩进在Spyder (我认为是NumpyDoc格式)中生成各种类型的格式？
我没有看到任何关于上的缩进和自动列表的讨论。
浏览 2修改于2020-01-21得票数 1
回答已采纳
我正在使用带有numpydoc扩展的sphinx。 当我制作html时，我的“示例”段落中的每一项都被破坏了。
浏览 26修改于2019-06-03得票数 0
有关numpydoc docstring约定的问题：
我有一个类，它包含一些方法，这些方法不返回任何内容，但是向类添加了一个属性。
浏览 2修改于2020-01-22得票数 1
回答已采纳
我遵循numpydoc 来记录我的代码，但找不到返回类实例的约定：
"""Create an index in the meilisearch API.
浏览 1提问于2019-12-09得票数 1
回答已采纳
我试图使用numpy docstring格式记录一个元组返回值，但无法使它与pycharm类型暗示一起工作。要记录的函数示例： foo = 42 example : 1337, }现在，我可以用一种方式来记录它： """
This is the functio
浏览 2提问于2019-05-09得票数 4
回答已采纳
我正在使用为Python项目编写文档。使用一个扩展名而不是另一个扩展名的利弊是什么？
浏览 3修改于2020-04-07得票数 14
在尝试遵循DocStrings的DocStrings格式时，我似乎想不出如何告诉用户参数是关键字参数(即。指定为SomeFunc(theKeyWordArg=100)，而不是SomeFunc(100) )。def somefunc(arg1, arg2):Parametersarg1, arg2 : int对于关键词论点：...
但他说，在一般情况下，这是我在许多职能
浏览 4修改于2020-01-22得票数 3
我有这个功能 def foo(bar): """ Parameters bar: func(var1: list[str], var2: str) -> str return bar(var1, var2)
浏览 16提问于2020-08-23得票数 0
回答已采纳
这里的主要问题是哪里(如果)有一个objects.inv为TensorFlow，但如何实际使用它将是一个很好的例子。"""---------- The directory of checkpoints. A Session to use to restore the parameters.
saver : tf.train
浏览 2修改于2020-01-21得票数 7
我想，也愿意自己写一个PyCharm插件，它可以创建一个以谷歌或Numpydoc风格()格式化的文档评论存根。这里特别重要的是将PyCharm具有的类型推断能力与其他两种文档类型结合起来。
浏览 6修改于2020-01-22得票数 79
回答已采纳
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号