python-sphinx 相关问题

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

我如何在带有Sphinx的reStructuredText中包含一个plantuml文件

我有一个具有以下内容的plantuml文件Composite.puml：包Composite {类Letter {+ __init __（char：str）＃print_this_before（）}并且我尝试将其包括在...

python python-sphinx restructuredtext plantuml

回答 1 投票 0

readthedocs构建时如何删除doctest标志？

我已经发布了我的Python软件包，并将文档托管在readthedocs上。我想知道如何从以下文档中删除doctest标志（例如doctest：+ ELLIPSIS）：https：//camphr.readthedocs ....

python python-sphinx read-the-docs

回答 1 投票 0

如何在长函数签名中使用换行符，并在Sphinx autodoc中对其进行格式格式化

我有一个带有类型提示的长签名的函数，如def set_parameters（tokenizer：Union [None，“ Tokenizer”，str] = None，vocab：Optional [“ Vocab”] = None，vocab_from：...] >

python python-sphinx signature pretty-print autodoc

回答 1 投票 0

Sphinx不删除html输出中的doctest标志

我无法消除html输出的doctest标志（即，＃doctest：+ ELLIPSIS）。我能够根据需要生成文档，因此那里没有错误，但是它包括...

python python-sphinx doctest autodoc numpydoc

回答 1 投票 1

Sphinx未记录复杂的Enum类

在我的代码中，我有一些复杂的Enum类型的类。例如：class ComplexEnum（SomeOtherClass，Enum）：“”“一些文档”“” MEMBER1 = SomeOtherClass（1）MEMBER2 = ...

python enums python-sphinx autodoc

回答 1 投票 1

Python的Sphinx autodoc扩展> 3.5 docstring由于函数参数类型不起作用

我一直在尝试使autodoc自动记录我的python 3.7模块。我需要记录的唯一文件是一个模块中的init.py文件。该文件仅包含函数，并且...

python python-sphinx read-the-docs

回答 1 投票 0

如何将外部文件，例如来自https://raw.githubusercontent.com/的源代码包含到.rst文件中

literalinclude可用于包含/导入本地存储库中存在的源代码或文件。是否有一种方法或指令可以从远程URL包含文件，例如https：// raw ....

python-sphinx restructuredtext

回答 1 投票 0

狮身人面像（文档）应如何与文档字符串一起使用？

python python-sphinx autodoc

回答 1 投票 0

Doxygen + Sphinx +呼吸+呼气

目前，我正在研究项目文档。当我在conf.py中包含源文件和头文件时，HTML成功生成。但是当我只想使用源文件来记录HTML ...

python-sphinx doxygen

回答 1 投票 0

为什么无法在我的狮身人面像中搜索该短语？

我已经安装了python文档generator-sphinx，并在其中发布了一些文章，最近我发表了一篇名为股票筛选器的文章。输入筛选可以得到它。在...

search python-sphinx restructuredtext cjk

回答 1 投票 3

Sphinx的autodoc的自动模块显然没有任何作用

我正在包含自动模块的第一个文件上运行Sphinx，但似乎没有任何效果。详细信息如下：我有一个Python项目，其中文件agent.py包含一个Agent类。我...

python python-sphinx autodoc sphinx-apidoc

回答 1 投票 0

在狮身人面像中导出html，无需自定义警告

跟随我的其他问题，在狮身人面像文件中显示/隐藏文本的一部分（问题/答案），我想做的是导出没有此标签的html（或其他格式）（例如，没有所有...的html）] >

python-sphinx

回答 1 投票 0

Sphinx文档和autodoc-skip-member

我正在通过以下方式为django项目构建我的sphinx文档：sphinx-apidoc app -o docs / source / app --force现在它包含了所有我不想包含的South迁移。 ..

django documentation python-sphinx sphinx-apidoc

回答 2 投票 7

自动文档在django ImageField上失败

我正在尝试使用sphinx来记录我正在编写的Django应用。到目前为止，我已经有了我的code.rst设置来查看models.py，当我运行make html时，我得到了自动文档，但是我得到了...

django python-sphinx autodoc

回答 2 投票 4

如何在Sphinx中的方法内部自动记录功能

代码示例：class A（object）：def do_something（self）：“”“ doc_a”“” def inside_function（）：“”“ doc_b”“”我尝试通过：.. autoclass :: A ...

python documentation python-sphinx restructuredtext autodoc

回答 1 投票 2

autodoc和明确指定的实例属性存在的问题

我编写了一个python类，并使用sphinx编写了文档。例如，该类如下所示：class Aclass（object）：“”“ my class”“” def __init __（self）：“”“构造函数”“” ...

python python-sphinx autodoc

回答 1 投票 4

在Sphinx中引用自定义图形类型

如果我尝试引用自定义图形类类MyFigure（sphinx.util.docutils.SphinxDirective，docutils.parsers.rst.directives.images.Figure）：通过def setup（app）：app.add_role（'...

python-sphinx restructuredtext docutils

回答 1 投票 0

模块中的Sphinx autodoc函数

我刚开始使用狮身人面像并愿意学习。我想将我的各种功能分解为index.rst文件中的不同部分。因此，每个函数都有其自己的标头。所以...

python documentation python-sphinx docstring autodoc

回答 1 投票 5

如何使用autodoc覆盖Sphinx中的构造函数参数？

假设我有一个这样的类：class MyClass（object）：“”“该类的摘要文档。该类的扩展文档。”“” def __init __（self，* args）：self.values = .. 。

python python-sphinx autodoc

回答 1 投票 6

在带有部分的Python模块中构建Sphinx autodoc文档

我正在尝试改善python模块的文档结构。现在，我有一个Sphinx index.rst文件，如下所示：目录：.. toctree ::：：maxdepth：3 .. automodule :: ... ... >>

python python-3.x python-sphinx restructuredtext autodoc

回答 1 投票 4

python-sphinx 相关问题

最新问题