我正在使用Sphinx autodoc功能根据我的 Python 库的文档字符串生成文档。

交叉引用的语法可以在这里找到

标签必须在该部分之前，以便允许从文档的其他区域引用该部分。

我拥有的是我的一个类的 .rst (ReStructeredText) 文件。它用

为类生成文档。

我的问题是，如何从文档中的另一个 .rst 文档中引用该类的自动生成方法？如果我尝试在方法的文档字符串中放置标签，Sphinx 会抱怨。如果我尝试在方法标题之前放置标签，Sphinx 将无法识别它。

有没有一种简单的方法可以做到这一点，或者我是否必须在我的类文件中明确写入方法名称并在其前面加上标签？

这是 [Python 文档2中做我需要的事情的参考示例（我假设它使用了 autodoc 功能，尽管我不确定）

我有一个模块，我在其中创建了一个函数chain（有点像itertools.chain），所以我想我也会模仿itertools接口并公开一个chain.from_iterable函数。为此，我只需定义另一个函数，然后chain像这样用胶带将其粘贴到上面：

在某处_create_chain：

两者chain都有chain.from_iterable文档字符串，一切正常，但我想用 Sphinx 自动记录chain两者。chain.from_iterable现在我有

并且它为 创建文档，但是为结果chain添加另一个autofunction指令，因为它认为是一个模块：chain.from_iterableImportErrorchain

chain.from_iterable在这种情况下如何包含文档？

所以我决定做这样的事情：

我需要

但具有以下功能

所以，我需要为每个函数、方法和类写一些东西，但同时我还需要我在代码中创建的所有新函数都将出现在文档中，而无需编辑文档。有可能吗？

在记录实例变量时，我可以

这不适用于并行分配

如何在并行赋值中记录变量？

我花了很长时间在互联网上寻找使用 jsdoc 正确记录回调的最佳方法，但不幸的是，我还没有找到一个很好的方法。

这是我的问题：

我正在为开发人员编写一个 Node.js 库。该库提供了开发人员将使用的多个类、函数和方法。

为了使我的代码清晰易懂，以及（希望）将来自动生成一些 API 文档，我已经开始在我的代码中使用jsdoc来自我记录正在发生的事情。

假设我定义了一个如下函数：

使用 jsdoc，我目前正在记录此功能，如下所示：

我觉得上面的解决方案有点hack-ish，因为我没有办法绝对指定回调函数应该接受什么。

理想情况下，我想做类似的事情：

以上似乎可以让我更简单地传达我的回调需要接受的内容。那有意义吗？

我想我的问题很简单：用 jsdoc 清楚地记录我的回调函数的最佳方法是什么？

感谢您的时间。

我正在尝试链接到apply()autodoc 文档：http ://pandas.pydata.org/pandas-docs/dev/generated/pandas.DataFrame.apply.html 。

我可以通过使用链接到发布页面：http ://pandas.pydata.org/pandas-docs/dev/release.html ...

...但我似乎无法获得到 autodoc 页面的正确链接。我的 intersphinx 映射配置为...

...并且我尝试了该apply()方法的以下链接变体：

回答

正如 mzjn 在下面回答的那样，该链接区分大小写，因此在我的情况下可以执行以下任何操作：

我使用 autodoc 记录了一些功能。在本地它运作良好。当我提交到 GitHub 时，文档是基于 ReadTheDocs 构建的，但没有我用“automodule”记录的函数。

我在我的 conf.py 中添加了：

但这无济于事。

这可能与我使用自己的 C 库有关吗？（我有我的.c文件，我编译得到.so）

我正在尝试使用 sphinx 和 sphinx 的 autodoc 功能来记录我的 python 程序，但是我在一个文件中遇到了问题，我以以下形式进行了一些导入：

对于某些函数（即 asc、and_ 和从 SQLAlchemy 中选择），sphinx 在我的模块文档中也添加了它们的文档。令人惊讶的是，它只适用于这 3 个。我在同一个模块中导入 SafeConfigParser 类没有问题，我还有另一个模块从数学模块导入函数没有这个问题。

有关信息，.rst 文件如下所示：

欢迎任何帮助，在此先感谢！

我正在尝试使用sphinx（与autodocand结合使用numpydoc）来记录我的模块，但在基本设置之后，运行make html只生成基本的 html，不包含任何文档字符串。我正在运行Python 3.3，项目结构的大纲如下：

__init__.py是空的，在我添加conf.py的目录中docs/sourcesys.path.insert(0, os.path.abspath('../..'))

make html在目录中运行docs会给出以下输出：

那么，我做错了什么？

我正在使用sphinx来记录一个项目，并且在使用装饰器中包装的函数时遇到问题。我见过类似的问题，但似乎没有适合我的问题的解决方案

我有数百个函数都包装在一个自定义装饰器中，该装饰器本身可以接受参数

然后我的功能将如下所示

现在，当我使用 sphinx 和 autodoc 来生成我的文档时，包装在 CustomFunctionDecorator 中的所有函数都隐藏了 sphinx 文档中函数的实际参数，并且看起来像这样

测试文档

该文档有效，但函数参数不....

有任何想法吗？希望我说清楚了