python-sphinx 相关问题

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

Markdown中Sphinx的``raw：html`相当于什么？

问题标题应该是自我解释的。我在Markdown of Sphinx raw中找不到任何东西。我知道我可以在md文件中直接输入html，但是我有一个非常长的html代码片段，我...

markdown python-sphinx

回答 1 投票 0

Sphinx扩展在Sphinx中使用GitHub markdown表情符号？

我一直在使用（Python）Sphinx文档以及CommonMark解析器来编写Sphinx文档的问题，其中包含以reStructuredText和Markdown编写的文件。到目前为止一切正常，... ... >>>

python-sphinx emoji github-flavored-markdown

回答 2 投票 7

如何在RST /读取文档的代码块中添加复制按钮

我一直在制作个人的“操作指南”，记录和记录我的学习日记。我现在有一个，几乎太长的代码块，当我遇到这个长度时......

html clipboard python-sphinx restructuredtext read-the-docs

回答 1 投票 3

由于json指针，Sphinx无法包含我的JSON定义文件

我正在使用Sphinx记录我的JSON Schema以在ReadTheDocs上托管它。当我在我的主模式文件中有我的定义一切都很好。但我想将我的定义移动到外部json文件。我......

json python-sphinx jsonschema jsonpointer

回答 1 投票 0

Sphinx：突出显示支持的语言列表？

我正在使用Sphinx代码文档并在代码中使用多种语言，我想为所有代码设置突出显示。 Sphinx简要提到了它支持的一些语言（...

documentation-generation python-sphinx pygments

回答 3 投票 10

Python和sphinx：多行google风格docstring中的项目符号列表

我目前正在使用Sphinx记录我的Python项目。在文档字符串的多行部分中包含项目符号列表时，我遇到了一个问题。我想包括一个项目符号......

python python-sphinx docstring google-style-guide

回答 2 投票 3

重组文本TOC子组

我正在尝试使用指向不同rst文件的子组来获取TOC。这是我的index.rst：.. bonobo-trans文档主文件，由sphinx-quickstart于2月8日星期五18:09:07 2019创建。...

python-sphinx restructuredtext read-the-docs

回答 1 投票 0

如何在Python中记录模块常量？

我有一个模块，errors.py，其中定义了几个全局常量（注意：我知道Python没有常量，但我已经使用UPPERCASE按惯例定义了它们）。 “”表示......

python python-sphinx restructuredtext

回答 6 投票 43

在Pycharm中获取Sphinx以在生成的html中包含我的docstrings

我有一个运行3.7.2 Python解释器的Pycharm项目，我配置了Sphinx来生成文档。我的项目有以下结构：/ my_project / / docs / / src / / modules / ...

pycharm python-sphinx

回答 1 投票 1

在reStructuredText CSV表中创建引用

我有这样的CSV表.. csv-table ::: header：Name，BrowseName，DataType，Description：widths：16,16,16,52“Enabled”，“Enabled”，“Boolean”，“Alarm can。 ..“我想创造......

python-sphinx restructuredtext

回答 1 投票 0

Sphinx autodoc无法导入模块

我正在尝试使用Sphinx记录项目，并且遇到了一个问题，即从文件夹中仅导入某些模块。我的项目结构如下所示： |-主要| | --...

python python-sphinx autodoc

回答 2 投票 0

是否可以在Sphinx文档工具的html输出中嵌入音频文件？

可能没有在html输出中嵌入音频文件的特定指令，但是至少可以嵌入执行此操作的html代码，例如：＆...

python html5-audio python-sphinx

回答 1 投票 0

Python动态测试计划生成

我正在使用Sphinx进行文档编制，并使用pytest进行测试。我需要生成一个测试计划，但我真的不想手工生成它。我想到一个整洁的解决方案是...

testing pytest python-sphinx

回答 2 投票 1

Sphinx类属性文档

我一直在尝试记录基于MongoEngine的应用程序，但是我在Document类上记录属性时遇到了问题。我采取了正确的语法，这样做是...

python python-sphinx

回答 2 投票 7

重命名Sphinx autosummary toctree条目

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

python documentation python-sphinx

回答 1 投票 0

如何在Sphinx中创建词汇表？

我试着在我的书的最后写一个词汇表，其中也包含我的文档的标题内容（没有描述，只有对页面的引用）。我想把头条新闻变成......

syntax python-sphinx glossary

回答 2 投票 6

在Sphinx文档中显示字典数据

我在Python项目源代码中有一个字典，它描述了默认的配置值。字典很冗长。我希望看到其他格式的Sphinx文档中的字典...

python python-sphinx

回答 2 投票 10

将交叉引用添加到另一个页面中的子标题或锚点

如何将reST / Sphinx页面中的交叉引用插入同一文档集中另一页的子标题或锚点？

python-sphinx restructuredtext

回答 4 投票 78

sphinx-build失败 - autodoc无法导入/查找模块

我正试图开始使用Sphinx并且似乎有无情的问题。命令：docs / sphinx-quickstart我回答所有问题，一切正常。命令：docs / ls一切看起来......

python documentation python-sphinx

回答 7 投票 75

以下行为之间的区别是什么：func：和：meth：Python Sphinx中的角色？

http://www.sphinx-doc.org/en/stable/domains.html#cross-referencing-python-objects上的Sphinx文档说：，py：func：引用Python函数;可以使用点名。角色文字......

python python-sphinx

回答 3 投票 9

python-sphinx 相关问题

最新问题