python-sphinx 相关问题

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

我正在记录一个巨大的Django项目我希望有一个选项来隐藏自动生成的Django东西比如下面的东西。这是我必须要 "处理 "的事情，还是有一个我还没有找到的设置？...

python django python-sphinx autodoc

回答 1 投票 0

我正在使用 sphinx 来生成一个项目的文档。我使用的是字段列表，引用了一个很长的url。我的reST脚本如下。**Operação*^^^^^^^^^^ :Fonte: https:/google.com.br :Github: ...

python-3.x python-sphinx restructuredtext

回答 1 投票 0

sphinx 文档将一个基类排除在 :inherited-members 中。

我正在用 Sphinx 记录一些有多层继承的 Python 代码。结构大致是： class _foo(np.ndarray): #do _foo stuff class bar(_foo): #do bar stuff class ...

python python-sphinx

回答 1 投票 0

如何使用Sphinx的automodule删除静态类变量？

我目前正在使用sphinx（第一次使用）为我的模块建立文档，我有一些类，其中有一些类变量是用默认值初始化的，例如：类 ...

python python-sphinx docstring read-the-docs

回答 1 投票 0

如何使用Sphinx的automodule删除静态类变量？

我目前正在使用Sphinx（第一次使用）为我的模块建立文档，我有一些类，其中有一些类变量是用默认值初始化的。例如：class ...

python python-sphinx member docstring autodoc

回答 2 投票 1

Sphinx文档 - 创建显示最新api请求的表格

你好，我想在Sphinx中生成一个状态概览表--一列包括最后一个api请求是否成功的信息（显示为复选标记），另一列包括相关的......。

python python-sphinx

回答 1 投票 0

我可以用Sphinx把所有的外部链接保存在一个单独的文件中吗?

我有一个Sphinx项目，其中包含外部链接的文件集合，每个文件的底部都有引用，像这样。一些带有`我的链接`_的文本，更多的文本是100行文本......。_我的...

hyperlink python-sphinx

回答 1 投票 2

Python Sphinx 警告：定义列表结束时没有空行；意外的未缩进。

我的文档是这样的： def segments(self, start_time=1, end_time=9223372036854775806, offset=0, size=20): """获取模型的分段:参数offset:- 可选int...

python python-sphinx

回答 1 投票 0

使用sphinx指令从python中创建一个链接列表。

我有一个rst文件，其中包含： ...include::other_file.rst，other_file.rst包含了一些类似的内容。* `文本项目1 `__ * `文本项目2

python python-sphinx restructuredtext

回答 1 投票 5

难以记录enum类？

我正试图记录一个我正在维护的模块我发现要正确记录我的枚举类非常困难。例如，这里有一个我想正确记录的类（源码）：......

python documentation python-sphinx

回答 1 投票 1

Sphinx在读取文档时出现 "模块未找到 "错误，但在本地构建正常。

我想在 "阅读文档 "上建立我的文档但我得到了一个可怕的 "未找到模块 "的错误。如果我在我的项目根目录下发布本地的make docs，一切都能正常构建，所以 "Module ...

python python-sphinx read-the-docs

回答 1 投票 0

重命名自动汇总的toctree条目。

我决定使用autosummary来创建模块的文档。在index.rst中，我已经 "导入 "了所有相关的模块和子模块的文档。这些模块被记录为...

python python-sphinx toctree

回答 1 投票 1

在toctree中使用self不包括子节。

我希望我在sphinx中的toctree包含主页面(index.rst)。文档中建议包括'self'就能做到这一点，但正如其他人在stackoverflow上指出的那样，这只包括标题......。

python python-sphinx toctree

回答 1 投票 6

如何在toctree中使用glob对标题进行排序？

我需要按标题对我的toctree进行排序。我使用:glob:属性，它只对我的文件名排序。你有解决办法吗？例子 : ... toctree:::maxdepth: 1 :titletsonly::glob: myfile1....。

sorting python-sphinx glob toctree

回答 1 投票 0

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

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

python-sphinx subdirectory toctree

回答 1 投票 3

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

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

python python-sphinx restructuredtext toctree

回答 1 投票 13

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

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

python python-sphinx read-the-docs toctree

回答 1 投票 0

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

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

python python-sphinx toctree

回答 1 投票 17

如何在Sphinx TOC中加入主页？

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

python-sphinx toctree

回答 2 投票 28

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

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

python python-sphinx pygments

回答 1 投票 1

python-sphinx 相关问题

最新问题