python-sphinx 相关问题

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

如何在本地构建Python文档？

我对要提交合并请求的Python文档进行了一些更改。但在此之前，我想将文档本地构建为HTML，以确保它看起来正确。 ...

python python-sphinx

回答 1 投票 0

sphinx超链接到以别名导入的Python模块的成员

我维护一个Python软件包，通常使用简短的标准化昵称来导入，以numpy导入为np或pandas导入为pd的方式。假设将foobar导入为fb。我正在使用...

python python-sphinx

回答 2 投票 2

'make'不被识别为内部或外部命令，可操作程序或批处理文件。 [狮身人面像]

我正在尝试研究狮身人面像python文档，我正在努力在目录中创建html。我已经在我的cmd提示符下尝试过了，但是显示错误。 $ make html我已经安装了...

python-sphinx

回答 1 投票 0

为什么从包含问号的第一个文件转换而来的html文件在单击目录时无法显示在浏览器上？

[我构建了一个python文档生成器-sphinx，当我单击第11篇文章http://127.0.0.1/build/html/python/Using%20iloc,%20loc,%20&%20ix%时，在其中添加一些文章20to％20select％20rows％20and％...

python python-sphinx

回答 1 投票 1

Sphinx-在代码块摘要中使用省略号（...）

考虑到您记录了一个长代码段，并希望用省略号…（…）和垂直省略号＆vellip;表示重复的值和其中的行。（＆vellip;）。这是一个...

python-sphinx

回答 1 投票 0

我可以引用另一个rst文档的标头并在保留在同一文件页面的同时保留该标头吗？

我正在使用sphinx，并创建了多个rst文件来整理我的文档。我使用了.. include :: 将多个rst文件包含到一个配置文件中，但是当使用：ref：`＆...

python-sphinx restructuredtext

回答 1 投票 0

为什么第一个文件包含？何时单击目录无法在浏览器上显示？

python python-sphinx

回答 1 投票 0

为什么在单击目录时sphinx中的页面无法显示在浏览器中？

python python-sphinx

回答 1 投票 0

如何在Sphinx toctree中添加标题而不添加新文档？

[好，我正在使用Sphinx Autosummary生成某些类的文档。共有三种不同的类，我希望我的侧边栏具有三个不同的部分，例如，如果我使用的是...

python python-sphinx restructuredtext

回答 1 投票 0

Python sphinx自动摘要错误

我有一个狮身人面像文档，当我包含以下行时：.. currentmodule :: myMod .. autosummary :: MyClass我得到以下错误ERROR：未知的指令类型“ autosummary”。然而，...

python python-sphinx

回答 1 投票 14

如何使用Sphinx apidoc仅记录__init__.py中导入的Python类？

因此，目前我正在使用apidoc为我的文档生成.rst文件，然后在其上使用autodoc。问题是我的程序包将代码分成许多不同的文件，从而导致此...

python python-sphinx autodoc

回答 1 投票 1

Sphinx apidoc-不显示软件包和模块的完整路径

我对狮身人面像很陌生，我正在尝试将其用作我的项目的API参考。也许之后也作为项目文档。我使用这两个命令生成它sphinx-apidoc -e -o doc / api ...

python python-sphinx

回答 1 投票 15

强制Sphinx使用longtable指令，以在长表中正确添加分页符

我正在一个项目中，我们在其中生成HTML和PDF的文档。当表的行数超过30行时，sp hinx会正确使用Latex longtable包。但是，对于较小的表，它...

latex python-sphinx

回答 1 投票 0

在将Sphinx autodoc与列表类型的模块数据成员一起使用时，抑制自动生成的Cruft

[我正在尝试使用sphinx.ext.autodoc来记录模块数据成员，该数据成员是SomeType对象的列表：class SomeType（object）：pass Foo = SomeType（）Bar = SomeType（）foo_bar = [Foo，吧] ...

python python-sphinx documentation-generation autodoc

回答 1 投票 0

如何让Sphinx-autoapi从源代码显示自定义注释

在python项目中，我生成了autoapi文档。特殊注释出现在生成的html文件中。例如，它正在工作并显示在最终的html页面上：def do_action（self，params）：“”“ ...

python-3.x python-sphinx

回答 1 投票 1

Sphinx-apidocs无法从python代码生成TODO文档

我安装了Sphinx api文档，该文档从我的python代码生成html文档。因此，唯一缺少的是它没有生成＃TODO文档。我在其他网站上查看过...

python-sphinx

回答 1 投票 1

我可以使用Sphinx在Django项目中写我的帮助文档

我有一个django项目，一个菜单选项是'Help'。帮助文档是使用Sphinx编写的，页面很多，例如索引，简介，第一视图，用户，词汇表。我用过...

django python-sphinx

回答 1 投票 0

使用Sphinx docs如何为HTML版本指定png图像格式，为Latex / PDF版本指定pdf图像格式？

[使用sphinx doc生成器，我试图将.png图像用于文档的HTML版本，然后我希望将.svg图像用于PDF / LATEx版本。任何人都知道如何“标记” ...

latex pdf-generation documentation-generation python-sphinx

回答 2 投票 7

Sphinx渲染渲染不一致

我具有以下reSt标记====================================== ** \ \ v **垂直制表符** \\\\ **反斜杠** \\'**单引号** \\“ ** ...

python-sphinx restructuredtext

回答 1 投票 0

如何在自定义指令狮身人面像中创建自定义警告？

我已经在Sphinx中创建了一个自定义指令“限制”，其中提到了某种产品的“限制”。我希望将限制写在类似于'note'或'...

python-sphinx custom-directive

回答 1 投票 0

python-sphinx 相关问题

最新问题