使用Sphinx 2.2.0和python 3.6.8 我有两个类，A和B，A的一个属性生成一个实例B。我希望我的sphinx html输出引用对象B，但我希望原始文档字符串不具有任何sphinx/rest格式。我正在使用autodoc，A中的大多数方法和属性都不需要这种修改，但如果可能的话，我想在几
浏览 20提问于2019-10-12得票数 1
回答已采纳
我用Python 3编写了一个程序，并使用Sphinx记录它。Sphinx的autodoc很棒，但是它只适用于Python 2。有些模块在autodoc中工作得很好，但是模块不能工作。一些例子: Python 2抱怨Python 3样式的元类，有些模块在Python 2中已经不存在了，比如however解析器。这很烦人，因为它不能从该文件导入文档字符串。我的一个想法是编写一个小程序
浏览 3提问于2011-04-09得票数 2
回答已采纳
3回答
我在试着记录名字。当我构建文档时，我会得到一个警告WARNING: duplicate object description和在文档化后相同的空函数。例如：
如何删除这些别名？我已经尝试过，向conf.py编写了几个函数来创建空属性。
另外，我认为值得一提的是，在构建完之后，我得到了一张使用:noindex:的便条，但我不明白我应该在哪里使用它？在我的docstring，rs
浏览 3提问于2020-05-03得票数 2
回答已采纳
我试图使用Sphinx中的autodoc打印特定模块中每个函数的docstring，但不包括模块的docstring。有可能吗？原因是我使用模块docstring来指定命令行选项(带有可爱的docopt)。
浏览 2提问于2013-07-29得票数 10
回答已采纳
2回答
扩展模拟类的类
、、、
我试图在扩展外部类的类上运行autodoc。import mock
for mod_nameclass extending_class (class_that_is_extended):
'
浏览 2提问于2014-09-17得票数 5
回答已采纳
1回答
狮身人面像:如何显示属性
、、、、
"" return True return False
使用Sphinx3.5.4和autodoc和napoleon扩展以及pydata_sphinx_theme作为conf.py中的主题，我得到了如下类的文档。我在.. automodule:: testm
浏览 12提问于2022-05-12得票数 0
我试图使用Sphinx1.4和sphinx-apidoc以及sphinx.ext.autodoc扩展为我的python类生成文档。我有很多模块，我希望每个模块只显示类名，而不是类中的完整方法列表(所有这些方法都在我的代码中有文档字符串)。我认为，当您运行sphinx时，设置了
浏览 7提问于2016-04-02得票数 8
回答已采纳
在python项目中，我生成autoapi文档。特殊注释出现在生成的html文件中。should pass..."""This variable hold some important data""""
浏览 0提问于2019-11-26得票数 3
回答已采纳
1回答
sphinx.ext.autodoc可以提取docstring并将它们放入docs/exampleproject.rst中。我的问题是:是否有一种方法可以自动地将某些部分附加到特定的文档中？理想情况下，我希望尽可能多地将我的文档放在源代码中，然后使用文档的源文件将这些信息按线性顺序排列。类似于：
在example_
浏览 0提问于2021-09-10得票数 1
回答已采纳
当使用Sphinx和autodoc记录Python项目时，可以使用:Example:在模块/类/函数docstring中包含一个代码示例，Sphinx将为您突出显示该代码的语法。差不多是这样。1000)[0, 1000)1000>>> rng.start>&g
浏览 2提问于2016-12-13得票数 1
回答已采纳
我开始用狮身人面像记录我的第一个基于异步的项目。我注意到有些项目在某些方法之前有这个"coroutine“前缀，我也想在我的项目文档中这样做，但是我不知道怎么做。该项目似乎使用了coroutinemethod指令来实现这一点，但我使用docstring内联地记录了我的所有函数和类，只有当您在reStructuredText文档中
浏览 0提问于2016-04-04得票数 4
泛型Python类(即参数类型)的Sphinx文档不显示初始化参数。'))
project = 'sphinx-autodoc-generic-class-bugThey can be
# extensions coming with Sphinx (named 'sphinx.ex
浏览 6提问于2020-09-18得票数 3
回答已采纳
1回答
以下两个属性定义在Sphinx autodoc HTML输出中显示完全相同：def concrete(self): pass
def abstract(self):
"""This is the abstract docstring"
浏览 0提问于2013-07-25得票数 6
1回答
我注意到狮身人面像呈现类描述的行为发生了变化。This is the body of the docstring description. var_int: int加上一些一般的狮身人面像设置，我大约两年前就得到了这个现在我得到了这个有没有办法告诉Sphinx不要将类变量添加到类定义的底
浏览 6提问于2020-10-29得票数 2
回答已采纳
我希望在我的Sphinx文档中只包含特定函数的docstring。但是，在没有使用的相关类和函数定义的情况下，似乎没有任何选项可以仅显示这些详细信息
我已经尝试按照中的描述创建了一个类，但我不确定这是否适合模板。我还尝试过autodoc-process-docstri
浏览 0提问于2011-10-20得票数 9
回答已采纳
我想使用Sphinx来记录我的Zope 2产品，并且最好也使用autodoc特性，它从我的模块中的文档字符串中提取信息。现在，在Zope中，不幸的是，docstring被用来指定通过http-请求访问的方法。因此，所有不应该通过http访问的方法都没有docstring。是否有一种方法可以以狮身人面像识别而不是
浏览 1提问于2013-09-19得票数 0
回答已采纳
我通过toctree指令手动链接的文档都可以正常工作。但是genindex链接到一个名为“索引”的空页面。我在我的api-docs/modules.rst顶部的toctree部分链接了结果index.rst.该链接正常工作，如果我通过api-docs单击就可以正确生成该链接。sphinx-autodoc还为我的</e
浏览 2提问于2020-11-05得票数 0
回答已采纳
我使用sphinx和autodoc扩展从python模块中的docstring自动生成文档。 :members:有没有一种方法可以告诉automodule记录所有的公共成员，以及这一个私有成员？我</
浏览 1提问于2019-01-31得票数 4
回答已采纳
我用狮身人面像记录我的项目，并使用sphinxcontrib.napoleon扩展，它允许我使用谷歌风格的文档字符串。这是我项目中的一个函数 """ qaid2_selnorms[qaid] = qfx2_normmeta
浏览 0提问于2014-10-23得票数 2
回答已采纳
Sphinx有一个名为automethod的特性，它从方法的docstring中提取文档并将其嵌入文档中。但是它不仅嵌入了docstring，还嵌入了方法签名(name +参数)。如何只嵌入docstring (不包括方法签名)？
参考文献：
浏览 1提问于2009-09-02得票数 11
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
腾讯会议
云直播
对象存储活动推荐
腾讯云开发者
