python-sphinx 相关问题

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

我如何在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

Sphinx python自动生成的文档失败

我想为名为Ulyxes PyAPI的API编写文档。我已经开始了，但是自动生成过程无法正常工作。当我单击...中的“自动生成的文档”链接时...

python python-sphinx autodoc

回答 1 投票 1

更改标题树标题文字的颜色

html css python-sphinx caption toctree

回答 2 投票 1

Sphinx-让自定义HTML知道变量

＃conf.py language ='en'html_extra_path = [“ customize.html”] {{变量}} {{语言}} 方式...

python python-sphinx

回答 1 投票 1

“准备文档”挂起-Sphinx中的toctree循环引用

我尝试使用Sphinx生成文档，但是生成过程挂在“准备文档..”上。我在寻找解决方案，但没有找到解决该问题的建议。 ...

python python-sphinx circular-reference toctree

回答 1 投票 1

搜索按钮中的狮身人面像问题

目前，我正在尝试学习狮身人面像以html格式生成文档，但是我发现一个问题是我无法使用搜索按钮来查找任何内容。我只搜索一个关键字，结果将...

python search-engine python-sphinx

回答 1 投票 1

指令和条目之间缺少空白行错误

我刚刚使用Sphinx创建了文档，这是我的问题：最初在Toc树指令中为空，然后在下面添加“教程”，它看起来像这样：.. toctree ::：......>] >

python-sphinx toctree

回答 2 投票 1

如何引用以单数形式定义但以复数形式表示的词汇表术语？

如果我定义了一个词汇表和一个叫做foobar的术语，那么我可以在文本中使用该术语，因为这是对：term：`foobar`术语的引用。然后，这会将foobar变成可点击的引用，将我带到...

python-sphinx restructuredtext glossary

回答 1 投票 1

Sphinx：如何更改html标题？

我正在处理我的RTFM文档，我想更改html标题。目前，我的标题如下： [页面标题]-我的文档文档一切...

python-sphinx read-the-docs

回答 1 投票 0

make html期间由于sys.path而出错

我正在尝试为软件包构建Sphinx文档，但我不断收到错误消息，可能会需要一些帮助。我的项目目录为bb_lite，代码位于后端文件夹中。 bb_lite ...

python python-sphinx

回答 1 投票 0

toctree中的菜单项在单击时会扩展/折叠，并且不会更改页面内容吗？

按照标题，是否可以有一个菜单项，其中整个项的作用类似于+/-，用于展开和折叠，并且不更改活动页面？有点像您已经在...

python python-sphinx read-the-docs expandable toctree

回答 1 投票 0

警告：toctree包含对Sphinx不存在的文档错误的引用

我几天前就开始使用Sphinx来记录python软件包，但我遇到了似乎是一个常见错误，但是我找不到解决方案。我使用了sphinx-quickstart来设置...

python python-sphinx toctree numpydoc

回答 1 投票 0

在表内部创建目录表

我希望能够在表格内生成目录。例如。它应该具有边框，如下所示：.. tabularcolumns :: | p {10.5cm} | p {1.1cm} | p {1.4cm} | p {1.1cm} | + -----------------------------......

python-sphinx restructuredtext tableofcontents docutils toctree

回答 1 投票 0

在Sphinx RTD网站上每个页面的顶部添加警告指令

我想在Sphinx RTD网站上每个页面的顶部添加一个简单的警告指令：..注意：：该项目的下一个主要版本将于X date启动。同时，我们是...

python-sphinx restructuredtext read-the-docs

回答 1 投票 1

未知指令类型“ toctree”。 Pycharm错误，但index.html可以工作

[在PyCharm中工作时，我在Sphinx中创建的文档的预览模式显示：系统消息：ERROR / 3（，第9行）未知的指令类型“ toctree”。 ..toctree :: :: maxdepth：...

pycharm python-sphinx preview autodoc

回答 1 投票 16

python-sphinx 相关问题

最新问题