Sphinx是一种工具,可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档,但它是一个通用工具,可用于记录任何内容。
我正在使用Sphinx扩展名自动摘要构建项目的文档。我想对文档所指的默认模板做些微改动。我能够...
我使用了如何在Sphinx中创建全局角色/角色中的建议,从http://www.cssbuttongenerator.com/向Sphinx添加了一个CSS按钮。我有..角色:: button:class:button And ...
这次我想在Linux中实现Sphinx。请给我做相同操作所需的API,否则相关链接也将执行。尽管我发现有很多PHP方面的内容,但是C ++方面却没有。我也有...
我正在尝试在Ubuntu 18.04上构建HTML文档,但是在运行make html时遇到了一个奇怪的错误:发生了异常:File“ /home/cybo/.local/lib/python3.6/site-packages / nbsphinx ....
Sphinx的Rinohtype前端:如何处理PDF字幕,默认情况下为'Release'
我正在通过Sphinx的rinohtype扩展名生成PDF(即,不是通过LaTex扩展名!)。对于两个捆绑的rinohtype模板“ book”和“ article”(我使用的是后者),...
我正在尝试从源代码中提取特定的代码段(测试)以将其输出到文档中。 TEST_CASE(“ std :: vector”){//! [MyTest] std :: vector v = {42,43}; CHECK(v ....
我正在使用:inherited-members:来显示父方法。在为孩子生成的文档中,是否可以引用孩子类? class Parent:“”“这是{Child class name} class ...
我在狮身人面像(1.2.1)中使用默认主题,我希望函数名称如它们出现在标题中一样(在函数docstring中带有args等),以某种方式变得更大,更好...] >
Readthedocs-需要sphinx 2.1+处理:async:选项
我的第一个公共Python项目现在在readthedocs(RTD)上。我正在尝试解决一个问题,但到目前为止没有成功。我正在使用:async:选项标记协程。 ...
Sphinx nit-picky模式,但仅适用于我明确编写的链接
我曾尝试打开Sphinx的nit-picky模式(-n)来捕捉我可能不小心造成的任何断开的链接。但是,它会在我记录类型的所有地方喷出错误。在某些情况下,我会...
rst2pdf AttributeError:“ PDFWriter”对象没有属性“ custom_cover”
无法'再创建PDF了,我可以早一些,但是后来我想我在Mac上弄乱了python安装...我运行了以下命令:sphinx-build -D language = de -b pdf / Applications / MAMP / htdocs / ...
如何使用Sphinx和RST链接类似键入的嵌套类和其他url
使用intersphinx和autodoc,具有::param存储:对象数组:type存储:list [dict [str,int]]将导致类似以下条目:stores(list [dict [str,int]])-数组对象。是否有...
我目前正在使用Sphinx(第一次使用它)来为我的模块构建文档,并且我有一些类具有一些用默认值初始化的类变量。例如:class ...
如何使用:private-members:在Sphinx中显示错误的成员值常量
如何在我的Sphinx文档中获取常量的值? .. automodule :: mymodule:members::private-members:这是我的测试模块:class Test:“”“”我的测试类“”“ ...
如何在我的狮身人面像文档中获取常量的值? .. automodule :: mymodule:members::private-members:这是我的测试模块:class Test:“”“”我的测试类“”“ ...
[Sphinx中有多个指令可以创建一个框式文本,例如.. note ::或.. topic ::,但它们都包含标题。是否可以创建没有标题的框式文本?
Python文档字符串图像嵌入Python文档字符串中,我有一个reStructuredText指令来显示图像:.. image :: ./images/code_quality.png除了图像以外,我还有一个小图标和一个路径:...] >
为字典关键字添加文档字符串的推荐方法是什么?我正在使用python 2.7和Sphinx。例如,在下面的代码中,我该如何为...
我使用Sphinx编写了项目的文档。我有代码示例(定义为代码块,包括在字面上,也仅以内联方式键入)。在这些代码示例中,有注释,但是当我...
在我的文档中,我偶尔会使用“垃圾”网址作为示例,并且不希望它们成为无处可链接的超链接。是否有任何语法可以使这些URL不再是超链接?