python-sphinx 相关问题

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

Sphinx文档，包括单元测试输出

这是一个操作方法/最佳实践问题。我有一个带有pytest的单元测试套件的代码库，我有一组* .rst文件，这些文件提供了每个测试的解释，以及一个表...

python-sphinx

回答 1 投票 1

Sphinx autosummary指令中的此“生成”选项是什么？

我正在使用sphinx api-doc和autosummary扩展来记录库的API，而我真的无法理解下面的generate /选项的目的：.. autosummary ::：nosignatures：...

python documentation python-sphinx

回答 1 投票 6

我如何在markdown文件中为Sphinx使用自动模块或自动分类？

我了解Sphinx可选地支持markdown或.md文件，这对我的补充文档非常有用。我想做的是在...

python documentation python-sphinx

回答 1 投票 3

是否可以为pytest测试自动生成文档？

我有一个仅包含pytest测试的项目，而没有模块或类来测试远程项目。例如。结构->。 ├──__init__.py├──test_basic_auth_app.py├──test_basic_auth_user.py├─...

pytest documentation python-sphinx

回答 1 投票 0

我如何为reStructuredText，Sphinx，ReadTheDocs等设置自定义样式？

我想用我自己的自定义样式扩展Sphinx和ReadTheDocs使用的主题。为了做到这一点，最好的方法是什么？

css python-sphinx restructuredtext read-the-docs

回答 2 投票 13

Python-sphinx-如何防止自动toctree条目编号

已修复，输入make clean html，然后使html重建项目。我正在使用Sphinx构建我的文档，以与readthedocs.io一起使用。到目前为止，这一直很好。我正在定向...

python python-sphinx read-the-docs

回答 1 投票 0

Bitbucket的管道无法识别已安装的python库

目标：我正在尝试在bitbucket管道中生成sphinx文档。问题：尽管有关管道的所有工作均正常进行，但狮身人面像似乎在查找某些模块方面存在问题：警告：...

python bitbucket python-sphinx bitbucket-pipelines

回答 1 投票 0

Sphinx autodoc不导入任何内容？

我正在尝试使用sphinx（与autodoc和numpydoc结合使用）来记录我的模块，但是在完成基本设置后，运行make html只会生成基本html，而文档字符串中什么也没有...

python python-sphinx autodoc

回答 2 投票 5

如何在Sphinx autodoc中重命名类

我对Sphinx文档框架有疑问。我正在编写类似熊猫的库，并且有一个.str访问器的类似物，它是由私有类（例如_StrAccess）实现的。所以我想...

python-sphinx autodoc

回答 1 投票 0

如何将外部文件和从索引添加到狮身人面像目录的部分？

我正在用sphinx构建我的python软件包文档，但是我很难将docs文件夹中其他文件的其他条目以及... ...上其他节中的条目都添加到目录中。 [

python python-sphinx tableofcontents

回答 1 投票 0

Windows中的Sphinx不会为模块创建文档

python-3.x windows documentation python-sphinx

回答 1 投票 0

Sphinx-在toctree和导航栏中处于同一级别，且文件分开

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

documentation python-sphinx

回答 1 投票 0

狮身人面像中的数字参考编号

使用狮身人面像1.3.6，我发现无法对数字进行编号引用。根据此处的答案和评论，在Sphinx和reStructuredText numref中引用带有数字的图形内置于...

python-sphinx

回答 1 投票 0

如何使内部链接在Sphinx输出（latexpdf）中起作用？

我在本手册后面插入了链接：http://sphinx-doc.org/markup/inline.html#ref-role但是，尽管内部链接在HTML输出中可以正常工作，但在PDF中却不起作用。文字应为...

reference latex python-sphinx restructuredtext

回答 2 投票 1

使用自动切片标签时引用本地标题

启用了autosectionlabel和autosectionlabel_prefix_document后，如何使用sphinx引用本地文档中的小节标题。我有一个详细的而不是嵌套的文件夹...

python-sphinx

回答 1 投票 0

如何使用Sphinx在INI文件中记录选项

我想在我的Sphinx文档中记录一个INI文件。我应该使用什么标记？每当我在网上搜索时，都会得到Sphinx配置文件conf.py的描述。标准域有一些...

python python-sphinx ini

回答 1 投票 4

Sphinx -python3 -m http.server-FileNotFoundError：[Errno 2]没有这样的文件或目录

我的问题-如何找出丢失的文件/目录？ Python3 http服务器在本地提供Sphinx html文件，但随后突然停止提供它们-我收到此错误...

python-sphinx

回答 1 投票 0

无法安装SPHINX-PermissionError：[Errno 13]权限被拒绝：'./source'

[Sphinx快速入门不会让我超越我们确定需要英文文档的步骤。我有一个现有的CONDA venv，名为-demo_venv。我激活它并进行pip安装，目录...

python-sphinx

回答 1 投票 0

将Python置于版本控制之下是否可行？

在可行的情况下，我喜欢在版本控制下拥有构建所需的工具。理想的情况是，在任何需要首先安装最少工具的机器上运行新的结账。将Python置于版本控制之下是否可行...

python version-control python-sphinx

回答 4 投票 3

为什么模板退出时rst2pdf为什么会给出TemplateNotFound错误？

我正在使用rst2pdf库通过Sphinx生成PDF文档。但是，当我尝试执行此操作时，我遇到以下错误：[exec] sphinx-build -b pdf -d stage / doctrees source / ...

python python-sphinx rst2pdf

回答 1 投票 0

python-sphinx 相关问题

最新问题