标题说明了一切。我想象的是为我的所有模块、类和函数提供文档字符串，并以某种方式通过github(wiki？)很好地浏览文档。此外，文档应该与最新代码同步，这意味着它应该在推送时更新/重新生成。这可能吗？ 最佳答案 只需将生成的docstring的输出通过管道传输到.md文件即可。像这样:pydocexample_lib>example_lib.md. 关于python-从Python文档字符串自动生成GitHubWiki文档，我们在StackOverflow上找到一个类似的问题：
在twisted的源代码中，很多文档字符串包含这样的格式:L{xxx}或C{xxx}或以'@'开头的行，它们的含义是什么？例如，在twisted/internet/interfaces.py中:defregisterProducer(producer,streaming):"""Registertoreceivedatafromaproducer....ForL{IPullProducer}providers,C{resumeProducing}willbecalledonceeachtimedataisrequired....@typeproducer:L{IProducer}pro
:rtype:指定这是返回对象的类型。因此，当我在以下代码片段中创建对象obj时，我收到来自IDE的警告，即clsisnotcallable，因为IDE期望cls是SomeAbstractClass类型的object，我想要SomeAbstractClass本身。IDE是正确的，因为这是默认行为。但是我如何指定我返回的是类，而不是类的实例？指定type而不是SomeAbstractClass有点帮助，但这不是解决方案，因为没有进一步的内省(introspection)可用。defclass_selector(data):""":rtype:SomeAbstractClass:retur
使用autodoc和类似的工具允许人们从源docstrings编译文档。然而，它似乎不允许函数或类文档字符串中的任意ReST部分标题，并产生错误:严重:意外的章节标题。我尝试在没有numpydoc的情况下遵循numpy样式指南进行记录时遇到了类似的问题:unexpectedsectiontitlewithsphinxisnumpytheissue和howdoesnumpyprocessdocstringsintosphinxdocumentationforparameters然而，在这里，我实际上是在编写JavaScript文档，并且只想在docstring中包含任意部分标题和ReST
当您键入以下内容时，有没有办法让IPython完全呈现reStructuredText(对于Sphinx)文档字符串:helpfoo或:foo?我发现在IPython显示原始标记时尝试阅读帮助文档super会分散注意力。reST非常适合Sphinx文档，但确实会使简单的帮助查找变得困惑。我不能一个人处理这个...？Google在这方面没有任何帮助。 最佳答案 我不认为这在IPython中是可能的，但看看Spyder:您可以从IDE中打开IPython控制台。文档字符串呈现为HTML。 关
也许是个愚蠢的问题:在编写C扩展时，如何为__init__等特殊函数指定文档字符串？对于普通方法，方法表提供了文档字符串。当我尝试help(myclass)时，会显示以下自动生成的文档:__init__(...)x.__init__(...)initializesx;seehelp(type(x))forsignature但这是我想要覆盖的。 最佳答案 我认为最常见的做法是将各种函数的定义粘贴到tp_doc中，然后就这样了。然后你可以按照它说的去做，看看你的对象的文档。这就是整个标准库中发生的事情。您真的没有任何选择可以在各种插槽(
我使用Sphinx和自动文档功能来确保我们的项目中有好的文档。所以我很熟悉infofieldlists我熟悉使用cross-referencing在我们的文档中。但是，在为方法或函数编写文档字符串时，我发现在文本中引用它们的参数很有用。但似乎没有一种结构化的方式来做到这一点。我们可以说例如Use``name``tosettheusername但这没有结构，需要你记住你使用的是什么风格，如果你改变风格，你必须寻找并杀死所有不正确的风格。:param:在信息字段列表之外不起作用，所以你不能写Use:param:`name`tosettheusername我见过一些项目使用:parm:但没有
如果函数的参数预期是某个(或等效的)结构，使用python的list、tuple和dict构建、如何和在哪里应该记录它？示例文档:deffoo(bar):"""Args:bar:2-tuple,([(,),...],)"""pass有点麻烦；一些问题:结构难以阅读很难指出结构中每个元素的语义如何表示不定长应该只记录一次，还是随处记录编辑:如何清楚地表明鸭子类型对于一个元素是可行的(即“dict”与“mapping-like”)编辑:这个例子不是试图强制类型，它试图记录一个结构。对于这一点，ducktypingok。 最佳答案 我在工
考虑filterNot的实现(基本上与filter相反):deffilterNot(f,sequence):returnfilter(lambdax:notf(x),sequence)参数f可以是一个“函数”或“方法”或一个lambda——甚至是一个对象，其类定义了__call__.现在考虑这个参数的一行文档字符串::param???f:ShouldreturnTrueforeachelementtobeabandoned现在，应该用什么代替???--参数f的type应该如何在文档字符串中引用.callable是显而易见的选择(如果我做主，我会说什么:P)但是是否有既定的约定？
我在Python中有很多这样的函数:deffoobar(one,two):"""Myfunction.:paramintone:Myoneargument.:paraminttwo:Mytwoargument.:rtype:Somethingnice."""return100+one+two我需要解析docstring以获得类似这样的字典:{'sdesc':'Myfunction.','params':[('one','Myoneargument.'),('two','Mytwoargument.')],'rtype':'Somethingnice.'}我可以使用sphinx.util
