python-sphinx 相关问题

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

将子目录中的toctree包含在索引toctree中。

我想记录的项目结构如下: top Index.rst a toctree_a.rst (包含doc和doc2) doc.rst doc2.rst b toctree_b.rst (包含......)

回答 1 投票 3

在Python Sphinx中使用toctree时,防止子节嵌套。

我在构建Sphinx用户指南时遇到了一个问题。我想通过一个主登陆页(index.rst)来形成一个章节,其中包含章节标题和概述,然后...

回答 1 投票 13

如何防止toctree条目自动编号?

我正在用Sphinx构建我的文档,以便与readthedocs.io一起使用。到目前为止,这一直都很好用。我把自己的方向定位在(在我看来)Godot引擎的优秀文档上。由于...

回答 1 投票 0

无法让斯芬克斯中的TOCTREE显示链接。

我是Sphinx的新手。我尝试了一下教程,但我未能在内容中生成链接。我得到的错误是 C:Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toctree contains refe ...

回答 1 投票 17

如何在Sphinx TOC中加入主页?

假设我有一个Sphinx项目,其源文件如下:index.rst installation.rst templating index.rst module.rst fieldtype.rst index.rst (主页)有如下TOC ...

回答 2 投票 28

如何定制Sphinx的代码块语言?

考虑以下情况: ... code-block:: my_lang ... 如果我想把my_lang做成Python这样的东西,我该怎么做呢?

回答 1 投票 1

在外部链接条目中不显示toctree编号。

我目前正在用Sphinx编写一个技术文档。我使用了一个编号的toctree。当我在toctree中插入一个外部网页链接时,渲染的条目不包含数字。对于这个...

回答 1 投票 1

为什么使用RTD主题的toctree不能更新?

我有一个使用Read-The-Docs主题的程序生成的sphinx-doc源代码。源码树看起来像: source ├── conf.py ├── index.rst ├── models │ ├── 1lin │ ├── 1lin_Amplero...。

回答 1 投票 6

如何将 "glob "标志选项提供的toctree倒序?

有谁知道有什么选项可以将toctree按文件名的降序排列? 如果是升序,我们可以使用:glob:选项,像这样:......toctree::glob:2011* 这将是方便的......

回答 3 投票 10

无法让狮身人面像在toctree下链接到另一个文档上

我试图学习sphinx,但只停留在基本的例子上。我在源目录下的make html中得到了以下错误。运行Sphinx v1.1.3加载pickled环境......。

回答 1 投票 6

在sphinx-js中记录一个简单的JavaScript对象。

我有一个使用JSDoc标签记录的对象,** *这个对象的一些描述。* @memberof Constants# * @readonly * @enum {string}。* @property {string} CONST1解释const......。

回答 1 投票 0

使用Sphinx的ReadTheDocs Theme文件夹结构。

我想创建一个数字版的讲义。我安装了sphinx,并修改了config.py文件,这样ReadTheDocs主题就可以工作了。我想有一个类似的结构,就像在 ...

回答 1 投票 0

下载角色无法使用 阅读文档

我试图使用 reStructuredText (reST) 和 Sphinx 让下载链接在 Read the Docs 中工作。在 reST 文档中,下载角色提供下载链接的例子是......

回答 1 投票 0

使用Sphinx的sphinx-apidoc工具从python代码中自动生成文档。

我想知道为了使用Sphinx的apidoc工具生成自文档代码,注释格式是什么。我能够让这个实用程序生成一组reStructuredText文件,用于 ...

回答 1 投票 4

将次要页面放在TOC的正确位置上

在我的狮身人面像文档中,我有一些次要的页面(当然)需要成为toctree的一部分,但我不能把它们列在正确的地方。如果我的 "第3节 "页面看起来是这样的。...toctree::...。

回答 1 投票 0

包括笔记本与nbsphinx失败

我是Sphinx的新手,我想写一个Python包的文档。当我想包含一个演示文件时,我遇到了一个问题。我想包含文件demo.ipynb,使用扩展名 ...

回答 1 投票 0

当从不同的toctrees引用时,生成不同面包屑的重复模板。

我的文档结构是这样的。├── common │ └── shared.rst ├── foo │ └── foo.rst ├── index.rst └── zoo └── zoo.rst 生成的结构是这样的。├── common │ └── shared.html ....

回答 1 投票 0

Sphinx toctree指令在更新后停止工作。

我经常生成的sphinx HTML文档在从fedora 20更新到21之后,突然停止显示toctree。模板仍然没有变化,包含了以下内容

回答 1 投票 0

在Sphinx中,我怎样才能在没有大量开销的情况下创建一个可链接的 "术语 "部分?

我想创建一个 "术语 "部分,其中包含我所使用的术语的定义,这样每次我在这个术语部分使用术语时,都会创建一个指向定义的链接。...

回答 1 投票 8

在Sphinx中使用noindex与词汇表。

当使用Sphinx 1.1.3时,我如何创建一个...词汇表::条目而不显示在自动生成的索引中?我试过在四个地方使用 :noindex:。在词汇表之前和之后使...

回答 1 投票 5

© www.soinside.com 2019 - 2024. All rights reserved.