python-sphinx 相关问题

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

我的包有一个结构，类似于以下内容： ├── 自述文件.md ├── __init__.py ├── 模块1 │ └── submodule1.py │ └── submodule2.py ├── 模块2 │ ├── __init__.py │ ├── _hiden_submodule1...

python python-sphinx docstring numpydoc autosummary

回答 1 投票 0

如何使用sphinx创建一个链接来下载rst中的目录？

我们可以将其添加到 rst 中以创建文件的链接：下载：`名称`。整个目录可以吗？ :download:`Dir ` 不起作用。是否应该始终预先

python-sphinx restructuredtext

回答 2 投票 0

如何在 rtd sphinx 中将网站内容（正文和导航栏）居中？

我正在使用 Sphinx 文档的阅读文档主题创建文档。我试图将整个网页居中 - 正文和左侧导航栏，这样如果

html css python-sphinx read-the-docs

回答 1 投票 0

使用位于 Filr（微焦点）的项目构建 sphinx 文档时出现问题

当我的项目位于我的桌面或其他地方时，我可以使用 sphinx 正常构建我的文档。不过，我的所有文件都备份在 Filr（micro focus）中。这就是我们...

python python-sphinx

回答 1 投票 0

如何在 Toctree Sphinx 中使用替换变量？

问题在于使用替换变量 var_link，该变量在 conf.py 文件中声明如下： var_link = 'https://www.google.fr/' 该变量通过以下方式添加到 rst_prolog 中 rst_prolog = ...

python-sphinx substitution restructuredtext toctree

回答 0 投票 0

如何在 Sphinx 中记录 Python 类的私有属性

我想将 Python 类的私有属性的描述添加到该类的 Sphinx 文档字符串中以提高代码可读性，但我希望自动生成的文档不显示这些属性。 C……

python python-sphinx sphinx docstring

回答 0 投票 0

ReadTheDocs：版本菜单不显示

我正在使用 Sphinx 和 ReadTheDocs 记录代码。单击 rtd 侧边栏底部的“v:latest”版本链接绝对没有任何作用。我有好几幕...

documentation python-sphinx read-the-docs

回答 0 投票 0

在 setup.py 上使用 sphinx BuildDoc

我正在选择 setup.py 中的 python 项目：从 sphinx.setup_command 导入 BuildDoc 命令 ["build_sphinx"] = BuildDoc cmd_opts["build_sphinx"] = { “

python python-sphinx setuptools packaging setup.py

回答 1 投票 0

Sphinx-js 找不到类文档

我正在尝试设置 sphinx_js 但我一直收到此错误： ~/test_sphinx_js$ sphinx-build -b html docs/source/ docs/build/html/ 运行 Sphinx v4.4.0 构建 [mo]：目标为 0 个 po 文件...

javascript python-sphinx

回答 1 投票 0

Sphinx 没有导入目录中的所有文件

我想为我的代码创建一个 Sphinx 文档，但它无法正确导入所有文件结构如下所示： ├────配置 ├────文档 │ ├────建造 │ └────出处 │ └────conf.py └────老...

python python-sphinx autodoc sphinx-apidoc

回答 0 投票 0

如何使用 os.path 获取 Sphinx autodoc 的正确路径

我刚刚第一次构建 Sphinx 并生成了所有骨架文件。接下来我想添加另一个带有 Python 文件的路径供 autodoc 分析。 sphinx.ext.autodoc 在 conf.py 中作为

python python-3.x python-sphinx autodoc

回答 0 投票 0

警告：autodoc：尝试使用 sphinx 生成 python 文档时导入模块失败

查看sphinx文档生成python文档。当我使用不引用任何 python 源代码的 .rst 文件生成 html 格式的文档时，

python python-3.x python-sphinx sphinx

回答 0 投票 0

如何将外部文件包含为类似于代码块的 Sphinx 文档？

如何将外部文件包含为类似于代码块的 Sphinx 文档？我怎样才能让它成为语法颜色的样式？

python-sphinx code-documentation

回答 1 投票 0

在 sphinx 中创建一个与 `make latexpdf` 一起工作的角色（字体颜色）

我习惯写Rest文档，从来没有用过LaTex。我想做的是创建一些字体颜色角色，我可以添加内联文本（例如：红色：这个文本是红色的），这些角色在 htm 中都有效......

latex python-sphinx restructuredtext

回答 2 投票 0

如何使用Sphix的sphinx.ext.coverage的coverage_show_missing_items？

Sorry，我是一个新手，正在尝试将Sphinx 添加到Django 项目的自动生成文档中，并确保该项目有足够的文档覆盖率。我想配置 Sphinx 告诉我...

python django documentation python-sphinx documentation-generation

回答 1 投票 0

如何向自定义 Sphinx/JupyterBook 扩展添加枚举

我正在为 Sphinx/JupyterBook 编写一个名为 examplenum 的指令的简单扩展，它将添加一个以“示例”开头的新标题，然后将自动添加正确的部分 ...

python-sphinx jupyterbook

回答 0 投票 0

Sphinx 文档制作 pdf 输出制表符行而不是单个空格？

JSON {“站点”：“站点名称字符串”， “采样率”：“”， “记录长度”： JSON {"site" : "site name string", "sampling rate" : "<data sampling rate, Hz: float>", "record length" : <data record length: float>, 我正在用 sphinx 做一些 REST 文档以获得 pdf 输出。基本上上面是我希望它在输出中的样子，但结果是这样的。我在我的代码中只使用了一个空格，但它导致它变成了制表符。 JSON {"site" : "site name: string", "sampling rate" : "<data sampling rate, Hz: float>", "record length" : <data record length: float>, 我试过在 conf.py 文件中将 tab-width 设置为 1，但没有任何效果。

python-sphinx sphinx restructuredtext

回答 0 投票 0

使用 Sphinx 指令包含多个 RST 文件 .. include::

在我的 Sphinx 项目中，我想要一个包含多个 RST 文件的包含文件夹，我可以在其他项目中重复使用这些文件。我的源文件夹看起来像： \来源 \包括链接.rst # ...

python python-sphinx

回答 1 投票 0

如何在 Sphinx 中以编程方式创建文档树？

我正在创建一个生成大量 RST 文件的 Sphinx 扩展。既然我正式知道了他们的内容，我想通过直接写docutils来获得时间和空间，skippi ...

python python-sphinx restructuredtext docutils

回答 2 投票 0

RestructuredText 中的文字“*”

我正在看这段代码： def ook(*args): """一些愚蠢的功能。 :param *args: 可选参数。 """ ... 一旦我运行 Sphinx，我就会得到非常有用的错误：