python-sphinx 相关问题

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

在Windows的Sphinx中使用mermaid.cli的问题

我有一个简单的Sphinx项目，希望将美人鱼图表呈现为png。为此，我通过纱线安装了mermaid.cli，但尚未设法使它工作。我的尝试...

command-line-interface python-sphinx mermaid

回答 1 投票 0

如何使Python / Sphinx文档对象属性仅在__init__中声明？

我有带有对象属性的Python类，这些对象属性仅在运行构造函数时声明，例如：class Foo（object）：def __init __（self，base）：self.basepath = base ...

python attributes python-sphinx docstring

回答 2 投票 8

使Sphinx从pydoc生成RST类文档

我目前正在将所有现有（不完整）文档迁移到Sphinx。问题在于该文档使用Python文档字符串（该模块是用C编写的，但可能没有关系）...

python python-sphinx pydoc

回答 3 投票 7

如何向Sphinx文档添加自定义页脚？（reStructuredText）

[如果我有一些文档，例如Galleria的文档，如何设置它，以便当我运行make html命令时，它将在每个页面上添加自定义页脚？我看到我可以...

linux unix makefile restructuredtext python-sphinx

回答 1 投票 24

有关为Django应用程序编写文档的入门[关闭]

我想为我的一个基于django的项目编写一个文档。我发现django人为此使用了reStructureText和Spinx。我有以下查询。我如何开始...

python django documentation python-sphinx restructuredtext

回答 1 投票 4

在Sphinx的引用中保留内联代码

在狮身人面像中，如果我有以下标题声明：.. _somestuff：“这是代码”，这不是！ =============================渲染如下：这是代码，...

python-sphinx restructuredtext documentation-generation

回答 1 投票 36

如何在 Sphinx 文档中将成员注释为抽象？

以下两个属性定义在 Sphinx autodoc HTML 输出中显示完全相同： @财产定义具体（自我）： """这是具体的文档字符串""" 经过 @抽象属性定义

python python-sphinx python-decorators autodoc abc

回答 2 投票 0

如何查看Django中生成的HTML Sphinx？

[确定-我有一个要记录的Django项目-所以我安装了Sphinx。安装进行得很好，我可以将所有HTML输出到_build文件夹中。但是...问题是：我如何实际查看...

django python-sphinx

回答 1 投票 6

构建狮身人面像文档时无法导入模块

我正在使用Sphinx版本1.4.5。我的项目结构如下：+ src> main.py + docs（使用sphinx-quickstart生成）即使在docs / conf.py中将src文件夹添加到路径后，也可以：...

python python-sphinx

回答 3 投票 1

在文档字符串公式中使用'\ displaymath'指令

[我正在使用Sphinx文档包来记录我正在使用的一个小型Python工具包，我想描述各个模块通过...实现的数学公式...

python latex python-sphinx

回答 1 投票 10

如何使用Sphinx和自动摘要为每个Python模块创建函数表

我有一个Python包，其中包含许多模块，这些模块又包含函数（...无类）。我在Sphinx和autodoc / napoleon上取得了巨大的成功。我为...

python python-sphinx autodoc sphinx-napoleon

回答 1 投票 0

Sphinx：参考特殊方法

Sphinx允许通过intersphinx链接到外部文档（例如标准库文档）。是否可以链接到诸如__del __（）之类的特殊方法的定义，而不仅仅是制作...

python python-sphinx

回答 1 投票 0

有人用Sphinx记录C ++项目吗？ [关闭]

Sphinx是Python的新文档工具。看起来很好。我想知道的是：这对记录C ++项目有多合适？是否有用于转换现有文档的任何工具...

python c++ python-sphinx documentation-generation

回答 3 投票 44

我应该如何使用Numpy的样式记录类和对象的属性？ [关闭]

我一直在阅读Numpy的文档标准，并且似乎没有提及对象属性-仅涉及类属性。因此，例如，我将如何记录以下内容？ ...

python numpy scipy python-sphinx sphinx-napoleon

回答 1 投票 13

如何使用狮身人面像更改LaTeX PDF输出中的代码示例字体大小？

我发现sphinx生成的PDF中的默认代码示例字体太大了。我试过在生成的.tex文件中插手，例如在...

python documentation latex python-sphinx

回答 3 投票 9

在Sphinx文档中仅显示* docstring？

Sphinx具有一项称为自动方法的功能，该功能可从方法的文档字符串中提取文档并将其嵌入到文档中。但是它不仅嵌入了文档字符串，而且还嵌入了方法...

python python-sphinx autodoc

回答 1 投票 11

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

python-sphinx 相关问题

最新问题