python-sphinx 相关问题

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

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

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

python python-sphinx pygments

回答 1 投票 1

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

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

python-sphinx read-the-docs toctree

回答 1 投票 1

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

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

makefile python-sphinx read-the-docs autodoc toctree

回答 1 投票 6

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

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

sorting python-sphinx glob toctree

回答 3 投票 10

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

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

python python-sphinx restructuredtext toctree

回答 1 投票 6

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

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

javascript python-sphinx jsdoc

回答 1 投票 0

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

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

python-sphinx read-the-docs

回答 1 投票 0

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

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

python-sphinx read-the-docs

回答 1 投票 0

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

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

python python-sphinx sphinx-apidoc

回答 1 投票 4

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

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

python-sphinx sections read-the-docs toctree

回答 1 投票 0

包括笔记本与nbsphinx失败

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

python jupyter-notebook jupyter python-sphinx toctree

回答 1 投票 0

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

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

python-sphinx breadcrumbs tableofcontents toctree

回答 1 投票 0

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

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

python python-sphinx fedora sidebar toctree

回答 1 投票 0

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

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

python-sphinx restructuredtext glossary

回答 1 投票 8

在Sphinx中使用noindex与词汇表。

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

python-sphinx restructuredtext glossary

回答 1 投票 5

VOH

我有一个像这样的斯芬克斯词汇表术语，用替换来使用下标进行正确的格式化。

python-sphinx restructuredtext glossary

回答 1 投票 1

我的笔记的Sphinx来源的位置 - 警告：该文档不包含在任何目录中。

如何修复Sphinx底部的警告？我试图在Sphinx中拥有我的Python笔记。我把我的笔记放在单独的文件中，和index.rst在同一目录下。我得到了以下...

python python-sphinx glob toctree

回答 1 投票 2

更改Sphinx的目录模板。

我是用Sphinx用自己的模板弄出一个类似twitter bootstrap文档风格的文档：http:/getbootstrap.com2.3.2getting-started.html 在那里你可以看到导航上的...

html twitter-bootstrap templates python-sphinx toctree

回答 1 投票 2

Sphinx文件之间的链接功能

我一直在stackoverflow和官方文档中寻找答案，但仍然找不到解决方案。在Sphinx-doc主文档中，我有以下内容。目录: ... toctree:: viewsindex.rst db...。

python hyperlink python-sphinx cross-reference

回答 1 投票 2

在Sphinx中，单个builddir不工作。

我在Mac上工作，使用Sphinx 1.6.3为我的软件建立文档。最近我尝试了国际化功能，效果不错。但现在我想导出 ...

internationalization python-sphinx

回答 1 投票 0

python-sphinx 相关问题

最新问题