python-sphinx 相关问题

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

Sphinx Alabaster字体 - 标准库的设置是什么?

我在sphinx中使用了雪花石膏主题,但仍然无法使标准字体看起来像Falcon和Celery。看着falcon的conf.py我找不到任何与html_theme_options相关的字体,所以我想知道......

回答 1 投票 0

Sphinx HTML构建器渲染功能

我在我的第一个文件中包含了一个raw指令:.. raw :: html <html here>在HTML中,有一个动态放置的字符串,其中包含reStructuredText。因为它放在原始...

回答 1 投票 0

使用ReadTheDocs主题阅读Docs&Sphinx时删除Github上的编辑链接

我试图找出如何使用Sphinx中的_template覆盖选项覆盖默认的ReadTheDocs主题,以便在http://readthedocs.org上托管Sphinx文档。具体来说,我......

回答 2 投票 3

如何将Sphinx和Pycco用于Python文档?

我希望能够将Sphinx用于主项目文档,因此文档字符串必须在reStructuredText中,但我也想生成HTML以便以...的方式阅读内联注释。

回答 2 投票 1

是否有一个Sphinx reST Python docstring字段用于收益?

我正在尝试使用reST风格的文档字符串,即def foo(bar):“”“需要一个条形的方法:param bar:一个Bar实例:type bar:Bar有没有标准的方法来记录产量?我看了...

回答 2 投票 18

由于dyld而运行sphinx时出错:未加载库:@rpath / Python

我正在尝试使用sphinx来构建我正在开发的包的文档。我用过的命令用来工作。看起来我的机器上的图书馆链接已经消失了。我正在使用Mac。 &...

回答 1 投票 0

Toc / list包含sphinx文档中由automodule生成的所有类

我有一个python包即将从epydoc迁移到sphinx。软件包本身记录了sphinx自动模块功能。现在我想对...中的所有课程进行总结

回答 2 投票 5

如何为sphinx文档设置BASE URL?

我使用sphinx为我的项目创建了文档。我的文档的当前端点是/。我的问题是,如何让我的文档遵循文档/ 图案? EX。 &...

回答 1 投票 0

将构建sphinx文档添加到Python轮

我正在创建一个包装(并捆绑)DLL的Python包。我打算在车轮内部预装基于sphinx的文档,并可能添加一个入口点作为启动浏览器的便利......

回答 1 投票 1

Sphinx使用旧的模块代码

我使用Sphinx来记录我的代码,这是一个Python模块的集合。通过擦除我的源代码生成的自动生成的文档很好,但是当我点击“代码”链接时......

回答 1 投票 3

如何将intersphinx链接放入标准库文档中的任意方法?

我正在尝试使用Sphinx来记录项目,但我无法弄清楚如何使用intersphinx。我用这行:py:meth:`math.sin`来添加链接,但在输出中,它显示为粗体,而不是...

回答 2 投票 8

Sphinx:强制重建html,包括autodoc

目前,每当我运行sphinx-build时,只有在对源文件进行更改时才会拾取和使用内联文档字符串。我试过用-a开关调用sphinx-build,但这似乎......

回答 2 投票 14

链接到sphinx中的源代码文件

我在Sphinx中记录了一个python模块。我有一个完整的模块使用示例的源代码文件。我想引用这个文件。内联作为连续代码太长了。有没有 ...

回答 3 投票 10

Sphinx文档:从生成的PDF中删除空白页面?

默认情况下,Sphinx文档会输出格式化为双面打印的PDF。所以标题页和TOC之间有一个空白页,TOC和介绍,介绍和...

回答 1 投票 37

Sphinx - 参考来自不同位置的图像

我正在使用Python Sphinx(通过ReadTheDocs)。我有一个包含一些子模块的存储库,我正在尝试创建一个统一的文档,但仍然保留每个模块中的文档资产...

回答 1 投票 0

Python-Sphinx中Toctree的多个级别

我正在尝试使用sphinx来记录文档的多个“级别”,例如:Api参考手册教程等。这个想法是侧栏上显示的内容相对于......

回答 2 投票 7

Python MagicMock在使用装饰器时嘲弄太多

我试图通过Sphinx获取基于ReadTheDocs安装的文档。我正在记录的类继承自一个更大的框架,我无法轻松安装,因此希望......

回答 1 投票 0

如何在Windows中使用Sphinx创建PDF文档

我正在使用Sphinx为我在Windows中的Python项目创建文档。我需要生成PDF文档。我在Linux中找到了很多解释如何做到这一点,但没有很好的解释如何做...

回答 3 投票 12

使用restructuredText网格表设置列宽

我在rST中有以下网格表。我想控制HTML输出的列宽,以便Field类型占表宽度的20%,Description占30%,Example占50%。 ...

回答 1 投票 4

如何使用sphinx autodoc停止出现“索引”和“Python模块索引”?

我正在使用sphinx autodoc来检索类和模块文档字符串。当我使用autodoc时,sphinx会自动生成一个名为Python Module Index的丑陋页面。如果我......我只能禁用此页面

回答 1 投票 2

© www.soinside.com 2019 - 2024. All rights reserved.