Sphinx是一种工具,可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档,但它是一个通用工具,可用于记录任何内容。
Build Sphinx with Type Stubs Dependency
我正在尝试通过 sphinx-build 在一个使用 pandas 的诗歌项目中为一个包构建 sphinx 文档。 Pandas 本身没有类型,但它的类型存根位于不同的包 pandas-stubs 中。而...
我正在使用 Sphinx 为我的项目生成文档。 在这个项目中,我在 yaml 文件中描述了可用命令的列表,一旦加载,就会在 f...
我可以告诉 sphinx-build 停止寻找 index.rst. $ echo 'test' > readme.rst $ sphinx-build -C . .build readme.rst 这将抱怨索引文件主文件丢失...index.rst不....
Sphinx与autodoc "重复对象描述 "警告时,将成员分组到单独的文件中。
我在一个模块里有一些功能,我想在我的文档中把它们分成两组。我有三个文件:my_mod.rst my_mod =====......automodule::my_mod :no-members:......toctree::。
我们有1000多个文件和一个主题的斯芬克斯文档。我需要在一个页面(.rst文件)中插入一个javascript代码,就像这样: function myFunction() { alert("I am an ...</root>
我正在用Sphinx开发文档,想在目录中用横条分隔各部分。我经常在菜单中看到这种情况。有什么方法可以在sphinx中实现吗?
我正在记录一个巨大的Django项目 我希望有一个选项来隐藏自动生成的Django东西 比如下面的东西。这是我必须要 "处理 "的事情,还是有一个我还没有找到的设置?...
我正在使用 sphinx 来生成一个项目的文档。我使用的是字段列表,引用了一个很长的url。我的reST脚本如下。**Operação*^^^^^^^^^^ :Fonte: https:/google.com.br :Github: ...
sphinx 文档将一个基类排除在 :inherited-members 中。
我正在用 Sphinx 记录一些有多层继承的 Python 代码。结构大致是: class _foo(np.ndarray): #do _foo stuff class bar(_foo): #do bar stuff class ...
我目前正在使用sphinx(第一次使用)为我的模块建立文档,我有一些类,其中有一些类变量是用默认值初始化的,例如:类 ...
我目前正在使用Sphinx(第一次使用)为我的模块建立文档,我有一些类,其中有一些类变量是用默认值初始化的。例如:class ...
你好,我想在Sphinx中生成一个状态概览表--一列包括最后一个api请求是否成功的信息(显示为复选标记),另一列包括相关的......。
我可以用Sphinx把所有的外部链接保存在一个单独的文件中吗?
我有一个Sphinx项目,其中包含外部链接的文件集合,每个文件的底部都有引用,像这样。一些带有`我的链接`_的文本,更多的文本是100行文本......。_我的...
Python Sphinx 警告:定义列表结束时没有空行;意外的未缩进。
我的文档是这样的: def segments(self, start_time=1, end_time=9223372036854775806, offset=0, size=20): """获取模型的分段:参数offset:- 可选int...
我有一个rst文件,其中包含: ...include::other_file.rst,other_file.rst包含了一些类似的内容。* `文本项目1 `__ * `文本项目2
我正试图记录一个我正在维护的模块 我发现要正确记录我的枚举类非常困难。例如,这里有一个我想正确记录的类(源码):......
Sphinx在读取文档时出现 "模块未找到 "错误,但在本地构建正常。
我想在 "阅读文档 "上建立我的文档 但我得到了一个可怕的 "未找到模块 "的错误。如果我在我的项目根目录下发布本地的make docs,一切都能正常构建,所以 "Module ...
我决定使用autosummary来创建模块的文档。在index.rst中,我已经 "导入 "了所有相关的模块和子模块的文档。这些模块被记录为...
我希望我在sphinx中的toctree包含主页面(index.rst)。文档中建议包括'self'就能做到这一点,但正如其他人在stackoverflow上指出的那样,这只包括标题......。
我需要按标题对我的toctree进行排序。我使用:glob:属性,它只对我的文件名排序。你有解决办法吗?例子 : ... toctree:::maxdepth: 1 :titletsonly::glob: myfile1....。