python-sphinx 相关问题

Sphinx是一种工具，可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档，但它是一个通用工具，可用于记录任何内容。

numpydoc：记录鸭子类型的参数

根据numpy / scipy文档指南中的约定，应以以下方式记录函数参数：def foo（x）：“”“”该函数不执行任何操作参数---...

python documentation python-sphinx numpydoc

回答 1 投票 3

我应该记录类似功能签名的参数吗？

我有一些辅助函数，除了第一个参数外，其他函数与核心函数的参数相同。这些参数已在核心功能中完整记录。我应该复制粘贴此内容吗？

python parameters python-sphinx helper-functions sphinx-napoleon

回答 1 投票 0

Sphinx文档中的人类可迭代对象

Sphinx-autodoc展平字典，列表和元组-使长条几乎不可读。也不总是需要漂亮的打印格式，因为与嵌套的容器相比，某些嵌套的容器最好保持扁平化。...

python-sphinx restructuredtext autodoc

回答 1 投票 1

[Python Sphinx在生成pdf时跳过第一部分

我使用sphynx从静态.rst文件生成文档（不提取文档字符串）。我的存储库中有两个文件：index.rst .. toctree :: intro和intro.rst将被跳过========= ...

python latex python-sphinx pdflatex toctree

回答 2 投票 4

狮身人面像用于多个单独的文档

我对Sphinx很陌生，在服务器上记录了我的项目。现在，一位同事看到了我的工作，她想做同样的事情-在同一台服务器上记录她的项目。这些项目是...

python-sphinx toctree

回答 1 投票 4

在toctree中添加self的各个部分

我在获取目录（TOC）以显示文档首页的小节时遇到问题。我的首页上有很多部分，我希望这些是...

python-sphinx restructuredtext sections toctree

回答 1 投票 3

首先列出本地节，在TOC中最后列出链接的页面

假设我具有以下index.rst：一些全局主题===================== .. toctree ::：glob：嵌套/索引全局主题介绍------------------------和nested / index.rst：...

python python-sphinx restructuredtext tableofcontents toctree

回答 1 投票 3

在Sphinx中更改内部链接标签

python hyperlink python-sphinx sections toctree

回答 1 投票 3

sphinx生成类模块概述

我想让狮身人面像生成类似于doxygen生成的模块概述，这是一个示例，我找不到狮身人面像可以做什么，可以使用Graphviz生成某种图形，但是...] >

python graph python-sphinx graphviz

回答 1 投票 9

如何使用sphinx-autodoc引用字典？

：data：`〜package._module._DICT_NAME`不起作用； _DICT_NAME就像被引用一样呈现，但是没有超链接。与：obj：相同。不能将其放入函数中。

python-sphinx restructuredtext autodoc

回答 1 投票 0

返回Python Sphinx中的列表或元组

我正在使用sphinx进行文档记录，并且我具有返回列表/元组等的函数。因此，对于参数，以下指向python文档的链接：：param list myVar：但对于返回值...

python return python-sphinx

回答 1 投票 2

条件文档

是否可以使用Sphinx在函数中记录条件语句和其他语句？如果没有，是否还有其他具有这种功能的python库？

python conditional-statements python-sphinx

回答 1 投票 0

如何在报表上禁用函数名称

生成文档时，函数名有点问题。当我使用.. autofunction ::注解时，我得到的是函数描述以及函数名。生成时...

python python-sphinx

回答 1 投票 0

自定义globaltoc和localtoc html渲染

我正在使用Sphinx设置文档。我精确地说，我真的是这个库的新手。我的文档可以使用默认主题之一进行构建。一切正常：)现在，我想自定义...

python-sphinx tableofcontents

回答 1 投票 3

我如何在Sphinx globaltoc侧边栏中包含所有文档？

我希望将整个TOC中的每个文档都包含在globaltoc侧边栏中。我该如何实现？在主题文件中，有对{{toctree（）}}的调用，但我不知道什么是toctree（）...

python-sphinx sidebar tableofcontents toctree

回答 1 投票 2

Sphinx自动摘要为每个类生成两个摘要

我正在使用Sphinx + autodoc + autosummary为我的项目（mrpy）生成文档。我正在做一个两层的摘要，在index.rst中，我（至少）有mrpy ==== .. autosummary ::：...

python python-sphinx numpydoc

回答 1 投票 2

[尝试自动打包软件包时发生导入错误

我正在尝试开始使用Sphinx来记录我的一些小项目，但是似乎无法使它工作。我已经搜索过了，但是直到现在我尝试过的所有方法都没有解决...

python python-sphinx importerror autodoc

回答 1 投票 2

Sphinx的extlinks扩展名可以配置为显示url吗？

我非常喜欢我可以使用Sphinx extlinks扩展名缩短文本中URL的事实。我也希望在这里和那里也可以在呈现的文档中显示完整的URL，而无需...

python-sphinx restructuredtext

回答 1 投票 0

将xml内容添加到sphinx生成的文档中

所以这是我的问题。我正在尝试使用sphinx为我的项目生成文档，并设法获得基本工作，例如添加模块和图像。因此基本的index.rst看起来像：.. | ...

python include python-sphinx substitution

回答 1 投票 1

不同文件的标题不匹配

我在Sphinx中有一个非常基本的设置。 TOC如下：.. toctree ::：maxdepth：3一二，文件一和二看起来像这样：one.rst #### Part #### *******章*** **** ...

include python-sphinx restructuredtext sections toctree

回答 1 投票 2

python-sphinx 相关问题

最新问题