python-sphinx 相关问题

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

Sphinx在LaTeX输出中从0开始编号

我正在使用乳胶生成一个带有Sphinx的PDF文档。 ====================== RX-loader说明= ===================== Program = ======然而,这会产生0.1个RX-loader指令0 ....

回答 1 投票 1

Sphinx toctree编号未显示在外部链接条目上

我目前正在为Sphinx撰写技术文档。我使用编号的toctree。在此toctree中,我插入外部Web链接,然后呈现的条目不包含数字。为了这 ...

回答 1 投票 1

Sphinx将Markdown文件中的标题添加到文档结构中

我已将Sphinx配置为使用markdown文件。在我的index.rst文件中,我有... toctree ::: maxdepth:2:caption:内容:documents / Markdown在Markdown.md我有#Markdown ## H2 ...

回答 2 投票 0

未知指令类型“http:get”

我使用Sphinx和sphinxcontrib-httpdomain编写API文档。但是当我上次这样做(制作HTML)时,我收到了一个错误:阅读来源... [100%] administrator_operations ...

回答 1 投票 2

为什么sphinx-apidoc不能在这个travis / tox构建中找到包?

Travis构建:https://travis-ci.com/Laurentiu-Andronache/he/jobs/184044676 conf.py:https://github.com/Laurentiu-Andronache/he/blob/master/docs/source/conf。 py tox.ini:https://github.com/Laurentiu -...

回答 1 投票 0

使用Sphinx在Latex中自定义页眉和页脚

我们正在探索Sphinx的功能,以便重建我们的遗留手册。我们已将大部分以前的手册移植到Sphinx。现在我正在探索适应我们公司风格的可能性。 ...

回答 1 投票 3

是否可以为方法定义sphinx docs分别设置新行

是否可以为方法定义输入参数sphinx docs设置单独的新行:例如:它看起来像:lib.dashboards.post_all_dashboards(#black line ...

回答 1 投票 1

什么是数据结构类型(如列表)的Sphinx文档字符串标准?

Sphinx是否有一个支持的标准来记录参数或返回值类型不是一个简单的单个对象?例如,在下面,arg1是str,arg2是str的列表,...

回答 1 投票 6

Python Sphinx锚点在任意一行

如何使用Sphinx在ReST中的任意一行设置锚点引用?更清楚的是,这是一个例子:一个带锚点的标题----------------------这会产生一些......

回答 1 投票 4

所有都在rst文件中创建toctree

我有第2个文件:文件夹:| _file1.rst | _file2.rst file1.rst:.. toctree ::: maxdepth:3 Name1 ======== Name2 ======== file2.rst :.. toctree ::: maxdepth:3 Name3 ========= Name4 ====== ...

回答 1 投票 0

如何创建一个PDF-out-of-Sphinx文档工具

按照此链接尝试从Sphinx生成pdf:https://www.quora.com/How-to-create-a-PDF-out-of-Sphinx-documentation-tool $ sphinx-build -b pdf source build / pdf错误:找不到来源......

回答 5 投票 9

如何使用ReadTheDocs或Sphinx托管私有文档

我对这件事情全新。花了一整天试图找出“最常用”的方法。我想要实现的是像readthedocs.org,但对于私人客户(和...

回答 1 投票 9

如何使用sphinx-apidoc记录Python函数参数

我正在尝试清理我的python代码文档,并决定使用sphinx-doc,因为它看起来不错。我喜欢如何使用以下标签引用其他类和方法:class:`mymodule ....

回答 2 投票 16

对于Python文档,reStructuredText有什么真正的替代品吗? [关闭]

我很快就开始了一个开源Python项目,我正在尝试提前决定如何编写我的文档字符串。显而易见的答案是使用reStructuredText和Sphinx与autodoc,因为我......

回答 7 投票 50

Sphinx Autodoc输出顺序

是否可以更改Sphinx AutoDoc生成的输出顺序?特别是,我使用:private-members:指令包含私有成员。我想要的是私人......

回答 1 投票 0

使用相同的代码生成2种语言的文档

我可以用不同的方式生成2种不同语言的文档吗?问题是我有一个C API,它也通过类似VB的专有语言暴露。暴露......

回答 1 投票 4

狮身人面像:记录枚举的正确方法?

通过浏览Sphinx的C和C ++域,它似乎没有原始支持来记录枚举(更不用说匿名枚举)。截至目前,我使用cpp:type ::作为枚举类型,然后......

回答 2 投票 9

我需要做什么来为Sphinx“注册”'latexpdf'?

当我使用'latexpdf'运行Sphinx时,我得到一个错误,即使我在我的机器上安装了完整的TeX:Sphinx错误:生成器名称latexpdf未注册我需要做什么“......

回答 4 投票 4

Doxygen用于多语言API

我公司开发了工程程序API。它是用C ++开发的,但我们为以下语言创建了包装器:一种类似于VB MATLAB和Python的专有语言。 ...

回答 3 投票 8

Sphinx autosummary链接到导入的成员文档

我正在尝试记录一个有点复杂的python包它有几个私有子模块,即包+ - __init__.py“包初始化”+ - _info.py“包信息”+ - _core.py“包...

回答 1 投票 0

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