python-sphinx 相关问题

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

我想为计算机视觉领域的项目，模块和库集合准备一份文档（主要用c ++编写）。为此，我看了一下OpenCV文档和...

c++ opencv documentation doxygen python-sphinx

回答 1 投票 18

我正在尝试将pending_xref节点附加到handle_signature函数的signode，但是在docutils脚本中获取异常：发生异常：文件“\ python \ python37-32 \ lib \ site-packages \ docutils \ ...

python python-sphinx docutils

回答 1 投票 0

sphinx中参数部分之外的文本

我正在使用拿破仑语法为我的函数编写文档。我希望在文档中的参数列表之后有一个段落。文档目前看起来像这样：def x（a）：“”“A ...

python python-sphinx restructuredtext

回答 1 投票 0

为序列化参数接口创建使用文档

我正在尝试为我的项目创建文档，该项目通过串行接口具有特定的通信协议。协议的工作原理如下：请求数据：'command id''argument1''argument2'...

documentation python-sphinx restructuredtext

回答 1 投票 0

如何配置阅读文档以使用sphinx-autodoc-annotation？

我正在使用sphinx-autodoc-annotation来读取我的Python代码中的函数注释，并使用它来生成适当的预期参数类型和返回类型。它在我当地工作得很好......

python python-sphinx read-the-docs

回答 2 投票 2

自动模块在sphinx文档中生成toc

在Sphinx中，有没有办法让automodule指令生成类中成员的TOC？现在我有..内容:: ..主题::抽象bla bla bla .. automodule :: ...

python python-sphinx

回答 2 投票 3

如何在readthedoc和本地构建cython doc

我目前正在开展一个cython项目。在完成一些教程之后，我能够构建cython，然后使用sphinx build使用sys.path.insert（0，os.path.abspath（'../../'））＃...

python cython python-sphinx read-the-docs

回答 1 投票 0

虽然在anaconda.org上找不到Conda rst2pdf

我使用anaconda作为包管理器，并尝试安装rst2pdf，以便能够使用sphinx为python程序输出PDF。但是当我尝试运行已发布的版本时，我得到以下回读...

python anaconda conda python-sphinx rst2pdf

回答 1 投票 1

当推送到GitHub时，Sphinx文档在本地显示但不在URL上显示

我使用make html使用Sphinx生成了Python文档。当我在浏览器中打开index.html时，文档按预期显示，并且所有链接都按预期工作。然后我提交了所有文档并推送到...

python github documentation python-sphinx

回答 1 投票 0

以.rst格式从Sphinx中的文件导入多个表

我想在单个.rst中从多个源.csv文件导入多个表。类似于下面的东西。第一个样本：=======部分======= subsection01 ------------ .. csv-table :: my_table1：...

python python-sphinx restructuredtext

回答 1 投票 1

Sphinx，reStructuredText显示/隐藏代码片段

我一直在使用Sphinx和reStructuredText记录软件包。在我的文档中，有一些很长的代码片段。我希望能够将它们隐藏为默认值，稍微“......

code-snippets show-hide python-sphinx restructuredtext

回答 4 投票 15

我可以在GitLab上呈现HTML吗？

GitLab不为我呈现HTML，只是显示源代码：背景：我使用sphinx生成HTML并尝试在GitLab上显示文档。我查看了其他项目的存储库，...

html git gitlab python-sphinx

回答 1 投票 1

在制作自定义命名的sphinx_rtd_theme之后，SphinxRtdTheme未定义

我正在研究一个主题，它是sphinx_rtd_theme的一个分支。我重命名了主题，以便使用该主题的人不必担心覆盖他们通常的sphinx_rtd_theme。 ...

python-sphinx read-the-docs

回答 1 投票 0

在（Python）Sphinx Docs中包含文本文件*

（使用Python-Sphinx文档工具）我有一个.txt日志文件，我想构建到_build / html中。我需要在conf.py，index.rst等中进行更改。以下是布局：src / index ....

python python-sphinx

回答 2 投票 14

打印出Sphinx指令所在的方法/函数名称

我根据ToDo示例在pytest中为Sphinx文档创建了自己的扩展。这是从每个pytest test_function的每个文档字符串中读取和收集“test_summary”。 ...

python documentation pytest python-sphinx

回答 1 投票 0

如何为sphinx文档保留装饰类的文档字符串？

我有一个装饰器，它有一个包装类的嵌套定义。包装器将其包装的原始类维护为属性。玩具示例如下所示：def decorator（cls）：class ...

python python-sphinx python-decorators docstring

回答 1 投票 3

托管私人Sphinx文档[关闭]

我目前正在使用Sphinx为一个相当复杂的Django网站编写一些大量文档。我一直在内部工作，在我很快离开之前，我想留下详细的......

django python-sphinx

回答 2 投票 16

Sphinx与Django - Model没有声明一个明确的应用程序标签

我花了无数个小时，但这仍然停滞不前。文档非常缺乏。使用Django 1.10，尝试创建已经出现各种错误的Sphinx文档。最后我被卡住了......

python django python-2.7 python-sphinx

回答 2 投票 1

狮身人面像：“没有模块命名”

我正在尝试使用Sphinx为我的Python / Flask应用程序构建文档，但是我无法导入该文件。我在views.rst上导入views.py文件，但出现一条错误消息：没有模块...

python python-sphinx

回答 1 投票 0

在Google风格的Python文档字符串中“写”？

在Google风格的Python文档字符串中，可以按如下方式指定Args，Returns，Raises。 “”这是Google风格的一个例子.Args：param1：这是第一个参数.param2：这是第二个......

python python-sphinx

回答 1 投票 1

python-sphinx 相关问题

最新问题