python-sphinx 相关问题

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

禁用 Sphinx ReadTheDocs 主题中的顶部导航栏（面包屑）

我想禁用 ReadTheDocs 主题的顶部导航栏。对于其他主题，例如经典，它只是一个选项 html_theme =“经典” html_主题选项 = { “showrelbartop”：

python-sphinx read-the-docs

回答 3 投票 0

Sphinx automodule：如何引用同一模块中的类？

我正在尝试使用 sphinx autodoc 扩展，特别是 automodule 指令来自动为我正在开发的 django 应用程序生成文档。问题是我想创建

python django python-sphinx autodoc

回答 2 投票 0

如何在 rST 中的注释中引用子标题[重复]

我在文件夹 /pages/architecture-deployment-guide.rst 中有一个文件，该文件有两个子标题：查看每个容器接口的MAC地址 =============================================== 维...

documentation python-sphinx restructuredtext

回答 1 投票 0

如何在编写重构文本时引用另一个文件的子标题

我在文件夹 /pages/architecture-deployment-guide.rst 中有一个文件，该文件有两个子标题：查看每个容器接口的MAC地址 =============================================== 维...

documentation python-sphinx restructuredtext

回答 1 投票 0

在.rst中使用literalinclude和sphinx时出错

我正在使用 Sphinx 为 Python 项目生成文档。我想使用literalinclude 指令包含示例文件中的代码片段。但是，我不断收到错误&...

python python-3.x python-sphinx docutils

回答 1 投票 0

ReadTheDocs Sphinx 构建因版本错误而失败

我已经为去年 12 月发布的 python 库创建了文档。 https://monalysa.readthedocs.io/en/latest/ GitHub 存储库：https://github.com/siva82kb/monalysa/tree/main 我做了...

python python-sphinx read-the-docs

回答 1 投票 0

如何在 reStructuredText 的内联文字中包含超链接引用？

我正在将 Sphinx 与 reStructuredText 一起使用，并且我想在内联文字中包含一个超链接。然而，可以预见的是，如果我写结果的类型为``Foo_ -> Bar_``。 .._Foo：信息...

python-sphinx restructuredtext

回答 2 投票 0

Sphinx 快速启动不起作用

我正在尝试在远程计算机上安装sphinx。由于我无法访问根目录，所以我这样做了： $bash $mkdir -p ~/local/lib/python2.7/site-packages $export PYTHONPATH=$PYTHONPATH:~/lo...

bash installation root local python-sphinx

回答 6 投票 0

链接 Sphinx 替换

我有一个 Sphinx 项目，有一些替代品。我有一个变量 |total_downloads| （效果很好）我想在其上链接一些部分统计数据。我尝试了以下两段代码： :...

python python-sphinx restructuredtext cross-reference

回答 2 投票 0

如何在sphinx restructedtext中实现自动多级列表编号？

如何在sphinx reStructuredText中实现自动多级列表编号？假设文档中的某处有一个待办事项列表：（此处编号为手动编号） 1. 做一些#1 ...

python python-sphinx restructuredtext docutils

回答 1 投票 0

理解 Python 文档字符串中“两点”的使用

我目前正在学习 Python 文档字符串，特别是在 Google 风格、NumPy 风格和 Sphinx 风格格式的背景下。我注意到有时有两个...

python python-sphinx restructuredtext docstring numpydoc

回答 2 投票 0

列表项中的结束文字块

我的第一个文件中有一个列表项，我想在其中放入文字块，但我无法让文字块正确结束。这是我的第一个： 1. 第 1 项（非字面意思） 2. 第 2 项：：

python python-sphinx restructuredtext

回答 2 投票 0

如何定义在 RST 标记中的文本和公式中使用的数学符号？

这个问题与使用 RST 标记编写在 readthedocs.io 上发布的技术文档有关。我需要为可以重复使用的数学符号定义“快捷方式”符号...

math python-sphinx symbols restructuredtext

回答 1 投票 0

Math Latex 宏可在 reStructuredText 和 Sphinx 中进行替换

使用Sphinx和reStructuredText，是否可以定义数学宏来在数学Latex公式中进行替换？基本上，我想要有类似的东西 .. |bnabla|替换:: :...

python latex python-sphinx substitution restructuredtext

回答 1 投票 0

使用自定义 sphinx 解析器设置文档标题

我正在研究使用 sphinx 为非 python（技能，尽管与此处无关）项目生成文档。大多数函数都有文档字符串，因此作为第一种方法，我选择了创建...

python python-sphinx docutils

回答 1 投票 0

ReadTheDocs 传单菜单中不会生成自定义 PDF

这是我的 .readthedocs.yml 文件，其中包含从 simple-pdf 扩展构建 PDF 的命令。尽管构建成功执行了所有命令，但我在传单菜单中看不到 PDF。 # .阅读...

python python-sphinx read-the-docs

回答 1 投票 0

在sphinx的powershell中运行make.bat

我可以在 Windows 10 上的 Powershell 中执行这些命令 .\make.bat 清理 rm .\源下\*.* 光盘 .. sphinx-apidoc -o docs/source/bundle .undle\ -M 光盘文档 .\make.bat html 他们工作在...

windows powershell batch-file python-sphinx

回答 1 投票 0

Sphinx 是否已经适合 C++ 文档？ [已关闭]

我想尝试使用 C++ 的新项目的文档生成器。我认为我的选择是 Doxygen 或 Sphinx。由于我有一个 Python 项目，我想使用 Sphinx，所以我想知道...

c++ python-sphinx doxygen documentation-generation

回答 2 投票 0

如何将自定义CSS文件添加到Sphinx？

如何添加自定义 CSS 文件？以下conf.py不起作用： html_static_path = ['_static'] html_theme = '默认' html_主题选项 = { 'cssfiles': ['_static/style.css'] } 结果：米...

python css python-sphinx

回答 4 投票 0

Sphinx Docs 可以支持 Algolia 的文档搜索吗？

有谁知道 Algolia 的 DocSearch 免费文档服务是否可以集成到 Sphinx 文档网站中？

full-text-search python-sphinx algolia

回答 2 投票 0

python-sphinx 相关问题

最新问题