python-sphinx 相关问题

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

Sphinx中不推荐使用的标记类和/或方法

在Sphinx中是否有任何方法可以将类和/或方法标记为已弃用？我只能找到模块的已弃用选项。使用通用的警告是可行的，但不会带有语义含义。...

python python-sphinx deprecated

回答 1 投票 19

在Sphinx / reStructuredText中添加在新标签页中打开的链接

这里是相同问题的解决方案：在reStructuredText中的新窗口中打开链接，但是，当文档中有很多链接时（尤其是当链接位于表中时，此解决方案将...

hyperlink python-sphinx restructuredtext

回答 1 投票 0

Sphinx文档中的条件输出

我正在用Sphinx写一些文档，我只想为HTML文档而不是LaTeX文档打印某些文本块。东西告诉我我应该能够做到这一点...

python python-sphinx

回答 1 投票 21

让文档阅读包括特殊成员的autodoc文档吗？

我有一个模块，其中包含两个有文档记录的全球特别会员。在本地运行Sphinx会创建包含其文档的文档，但“阅读文档”则不会。它使用内置类型的文档...

python python-sphinx documentation-generation read-the-docs autodoc

回答 1 投票 21

我如何记录函数自变量的字典键？

我试图弄清楚如何在不使用Dict [str，str]的情况下为传递给函数的字典参数提供类型提示，因为这不提供键的含义。我已经尝试过...

python python-sphinx mypy python-typing

回答 2 投票 2

具有狮身人面像和scipy主题的功能格式偏移量

我正在使用scipy主题和狮身人面像以及autodoc + autosummary。构建文档时，在参数说明旁边会出现一个灰色框区域。相反，我希望它看起来......>

numpy scipy python-sphinx

回答 1 投票 0

我如何在reStructuredText（reST）中编写乘法符号？

我正在编写reST文档，这些文档将使用Sphinx呈现为HTML和PDF。我的源文件是UTF-8，并且希望我的HTML显示为UTF-8。编写...

utf-8 special-characters python-sphinx restructuredtext

回答 4 投票 2

Sphinx公共API文档

我有大量的python文件，我想为我的项目生成公共API文档。我用装饰器装饰过的api的所有功能。例如：...

python documentation python-sphinx

回答 1 投票 5

从epydoc移至狮身人面像以自动记录简单的python .py文件

Epydoc即使在应用补丁程序后也无法正常工作，因此我正尝试迁移到Sphinx。我想从一个简单的python文件自动生成文档：test.py安装后，然后...

python python-sphinx epydoc

回答 2 投票 1

如何在Python的函数文档字符串中指定多种返回类型？

我知道用于为Google样式构建文档字符串的语法，例如：def function_with_types_in_docstring（param1，param2）：“”“示例函数具有文档字符串中记录的类型。...

python documentation python-sphinx return-type docstring

回答 1 投票 1

在Sphinx中，我可以注册一堆应该始终转换为链接的关键字吗？

我的文档字符串引用了我定义的其他python类。每次Sphinx遇到这些类之一时，我希望它为该其他类插入指向文档的链接。是...

python python-sphinx

回答 2 投票 5

如何在Sphinx中进行依赖输出格式的替换

使用Sphinx，如何根据输出格式进行替换？基本上，我想使用html：| CLICK | Unicode ：： U + 21E8 elif乳胶：| CLICK | raw：...

python-sphinx restructuredtext

回答 1 投票 4

为文本块应用CSS和角色，而不是在Sphinx中使用内联跨度

前面的问题解释了如何为某些reStructuredText添加颜色范围。回顾一下过程：首先，您扮演角色。 ..角色：：红色使用：red：`解释后的示例...

python-sphinx restructuredtext

回答 1 投票 13

我的笔记的狮身人面像来源位置

您如何在底部修复Sphinx的警告？我试图在Sphinx中添加Python注释。我的笔记与index.rst位于同一目录级别的单独文件中。我得到以下内容...

python python-sphinx

回答 1 投票 2

使用Sphinx生成PHP代码文档？ [关闭]

Sphinx是一个Python库，用于从一组ReST格式的文本文件中生成漂亮的文档。不是用于全文搜索的工具，我也完全了解doxygen / phpdoc工具。我是...

php python-sphinx documentation-generation

回答 5 投票 27

我如何在python-sphinx中突出显示文本？

我正在寻找一种在python sphinx中突出显示文本的方法。我看过有关如何更改单个单词的字体颜色的文档，但是我想更改单个单词的背景颜色...。

python-sphinx restructuredtext

回答 1 投票 1

狮身人面像命名特殊成员

这是我第一次使用Sphinx，到目前为止我已经弄清楚了很多，但是有一个特别的警告提示我无法弄清楚它在告诉我什么。根据文档...

python warnings python-sphinx autoclass

回答 2 投票 1

使用Sphinx和distutils构建的C扩展名

我已经编写了一个Python模块，其中包括用C编写的子模块：该模块本身称为foo，C部分为foo._bar。结构如下：src / foo / __ init__.py

python distutils python-sphinx

回答 2 投票 7

如何在Jython项目中创建基于Sphinx的文档？

我正在使用Java编写的库来开发多个Jython项目。由于autodoc扩展，我想用Sphinx创建一些好的文档。但是，当我尝试创建html时，我...

java python jython python-sphinx

回答 1 投票 7

SPHINX-numref适用于HTML，但不适用于LaTex

我正在从事Sphinx项目的软件文档编制，其中包含很多数字。我使用“ numref”来引用图片。在HTML中可以正常工作。在LaTex中，我得到图。只有...

python-sphinx pdflatex pdftex

回答 1 投票 1

python-sphinx 相关问题

最新问题