python-sphinx 相关问题

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

python-Sphinx自动摘要生成的文档缺少所有dunder方法,除了__init__`

我正在使用Sphinx的自动摘要为模块的每个成员自动生成单独的rst文件。文档已按预期创建,但缺少生成的rst文件...

回答 1 投票 0

带有toctree的自动摘要还列出了导入的成员

我使用Sphinx和自动摘要来生成Python软件的文档。它工作正常,但生成的.rst文件也列出了导入的函数和类,这不是行为I ...

回答 1 投票 4

在toctree中选择软件包,但不选择模块

我正在使用Sphinx为存储库生成文档。 Sphinx toctree允许使用:glob:自动选择某些文档。我有一个形式为.. toctree :::maxdepth:1:glob:...

回答 1 投票 1

在toctree和导航栏中的级别与单独的文件相同

我想将文件层次结构与文档层次结构分开,我希望在不同文件中有四个相同级别的部分,最后两个要在同一个文件中,两个要在分开的文件中,] >

回答 1 投票 0

自动为Sphinx中的autodoc类创建toctree

我希望增加我的一个图书馆的文件。我一直在使用sphinx来帮助构建文档,并且最近开始探索autodoc扩展。似乎在大多数...

回答 1 投票 16

将狮身人面像目录划分为带有小标题的小节

我有一个Sphinx主文档,其中包括以下子文档:.. toctree :::maxdepth:2:numbered:doc1 doc2 doc3 doc4 doc5 doc6我想划分...

回答 1 投票 4

隐藏toctree中的特定文件?

我正在本地主机上使用readthedocs.org实例从github存储库构建HTML文档,我希望能够执行以下操作。目前,我有正在读取的文件的列表...

回答 1 投票 3

自动toctree更新

我不确定是否可行。但是我希望在编译过程中将多个.rst文件放在目录中。我希望这些文件自动插入到toctree中。我该怎么办...

回答 1 投票 2

如何使用glob对toctree中的标题进行排序?

我需要按标题对toctree进行排序。我使用:glob:属性,它仅按我的文件名排序。你有解决方案吗 ?例子:.. toctree ::::maxdepth:1:titlesonly::glob:myfile1 ....

回答 1 投票 0

狮身人面像中toctree的明确标题

我正在尝试在我的toctree中显式设置元素的标题。文档说应该是这样的:.. toctree ::关于字符串的全部 但是它只是打印标题的...

回答 2 投票 1

tox不会运行狮身人面像

我想从tox运行以下命令。 python setup.py build_sphinx -b html当我从控制台运行上述命令时,我已经将setup.py配置为构建文档(我从...

回答 1 投票 1

如何在Sphinx文档中显式呈现空白?

我是sqlfluff的维护者之一,我想在这里将类似的模式和反模式示例复制到flake8文档中:https://www.flake8rules.com/rules/E101.html目前...

回答 1 投票 0

如何自定义sphinx.application.Sphinx.connect事件?

我是Sphinx的初学者,我想了解操作机制。以下内容来自此链接。从sphinx.application导入Sphinx def html_page_context(app,pagename,...

回答 1 投票 0

如何通过链pandoc-> sphinx将Word文档转换为html文件并保留文档代码示例的选项卡

我想从有关python编程的word文档中创建一个HTML站点。我使用链字文档-> [pandoc]-> rst文件-> [sphinx]-> html站点。除了...

回答 1 投票 -1

Sphinx:如何交叉引用由自定义指令生成的目标

我在交叉引用由自定义指令生成的部分时遇到麻烦。这是指令:从docutils导入节点,从docutils.parsers导入rst类TestDirective(rst.Directive):...

回答 1 投票 5

Build error“必须只有一个参数:DEST_DIR”

在遵循了ubuntu18的官方RTD安装教程之后,对于一个名为test的项目,我设法完成了所有工作(甚至是webhooks),直到出现构建错误:...

回答 1 投票 0

Sphinx函数的自动摘要模板在哪里?

我正在使用Sphinx扩展名自动摘要构建项目的文档。我想对文档所指的默认模板做些微改动。我能够...

回答 1 投票 1

使CSS按钮成为Sphinx中的链接

我使用了如何在Sphinx中创建全局角色/角色中的建议,从http://www.cssbuttongenerator.com/向Sphinx添加了一个CSS按钮。我有..角色:: button:class:button And ...

回答 2 投票 1

C ++中的Sphinx(Linux)

这次我想在Linux中实现Sphinx。请给我做相同操作所需的API,否则相关链接也将执行。尽管我发现有很多PHP方面的内容,但是C ++方面却没有。我也有...

回答 2 投票 1

构建HTML文件时文件名过长错误

我正在尝试在Ubuntu 18.04上构建HTML文档,但是在运行make html时遇到了一个奇怪的错误:发生了异常:File“ /home/cybo/.local/lib/python3.6/site-packages / nbsphinx ....

回答 1 投票 1

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