python-sphinx 相关问题

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

在 sphinx-gallery 中捕获 sympy 数学输出

我正在尝试为使用 sympy 的模块编写一个 sphinx-gallery 示例。 我找不到一种方法来获得像数学一样的输出格式。 例如,在 jupyter 笔记本中,sympy expr 的输出...

回答 1 投票 0

Sphinx 在文字块中发出神秘错误

在 Sphinx(ReStructuredText 发布系统)中,是否有任何晦涩的规则限制文字块可以包含的内容? 背景:我的文档包含许多跟随双

回答 2 投票 0

reStructuredText/Sphinx 中的引用

我想将引用放入 reStructuredText 文档中的新块中。做到这一点的规范方法是什么?我在这里看到“引用的文字块”,但至少 GitHub 渲染器确实...

回答 1 投票 0

类型提示中的类型别名不会被保留

我的代码(此演示减少到只有几行)如下所示: AgentAssignment = 列表[int] def assignment2str(分配:AgentAssignment): 经过 生成的 html 文档有...

回答 3 投票 0

引用 myst-parser markdown 文件中的(sphynx autodoc 生成的)python 方法 (:py:meth:)?

我有一段由 sphinx :autoclass: 指令生成的 sphinx 文档 我想引用 mystmarkdown 文件中 python 方法的(文档字符串)生成的文档 从 我已经尝试过这个: {:p...

回答 1 投票 0

文档(Sphinx)和 Django 应用程序之间的链接

我为使用 Sphinx 编写的应用程序的用户提供了文档。到目前为止,文档都是用户可以访问的静态 HTML 页面。 我想在应用程序和

回答 1 投票 0

添加选项卡重组文本(第一个)文件

如何将第一个文件中的信息制成表格? 或者,如何保留文本中已插入的空白? 这样,当我将第一个文件(通过 Sphinx)渲染为 HTML 时,表格格式......

回答 1 投票 0

在 Sphinx 上实现自定义主题

我正在尝试在本地为 sphinx 实现我自己的自定义主题。我一直遇到这个错误: 找不到名为“custom_theme”的主题(缺少 theme.conf?)。 我的 custom_theme/ 中有一个 theme.conf

回答 3 投票 0

如何在 sphinx 中为生成的代码块设置标题

目前我正在使用以下代码生成代码块并在其中显示一些信息。 我想使用以下第一个指令设置标题。 .. 代码块:: python :标题:

回答 1 投票 0

Sphinx:链接到嵌入式二进制文件 (PDF)

我正在使用 sphinx 和 RST 生成一些 HTML 格式的技术文档,但在获取本地 PDF 参考作为超链接时遇到问题。我见过人们使用 :download: 链接到本地 PDF,b...

回答 2 投票 0

如何选择与Sphinx交叉引用时使用的文本?

使用 sphinx,我使用以下语法包含了一个图形。 .._struct_NiO: ..图::img/NiO.png :居中对齐 :宽度:400px 字幕很长很长... 在世界的另一部分...

回答 1 投票 0

继承时更改文档字符串,但保持方法不变

我正在构建一个 HTTP API,并将大量代码分解到一个超类中,该超类处理对对象集合的请求。在我的子类中,我指定操作应该使用哪些数据库模型...

回答 2 投票 0

Sphinx 抛出一些缩进错误,我不知道如何修复它们

这些是我从 Sphinx 收到的错误: 意外的缩进: [{ “资源”:“/c:/Users/User/Documents/GitHub/MIMIC/mimic/model_simulate/base_model.py”, “主人&qu...

回答 1 投票 0

如果存在超链接,如何翻译Sphinx的'parsed-literal'指令的内容?

问题描述 最近,我尝试使用 gettext 生成器生成的 gettext .po 文件来构建 CMake 文档。但是,我想知道如何翻译 parsed-lite 的内容...

回答 1 投票 0

如何在Jupyter Book中调整右手toc深度

是否可以在 Jupyter Book 的 HTML 输出中调整右侧目录深度(名为 Contents)?我想查看我在 Jupyter Notebook 中编写的每个标题。 默认情况下仅...

回答 1 投票 0

sphinx 无法找到 sphinx_rtd_theme

我是狮身人面像的新手, 我尝试在conf.py中使用 html_theme = 'sphinx_rtd_theme' 但当我运行“make html”时,我收到以下消息: 自版本 1 以来,sphinx_rtd_theme 不再是硬依赖项....

回答 2 投票 0

参考sphinx |版本|作为等宽字体并且没有前导空格

我正在尝试引用狮身人面像|版本|在我的 .rst 文件中的等宽块中(周围没有空格),如下所示...... 您可以使用以下命令安装 foo_project 库: ``pip install -U foo_project==|ve...

回答 1 投票 0

我正在使用狮身人面像主题雪花石膏。如何在电脑上获得更宽的屏幕?

窗口的内容部分对于我的预期用途来说太窄了。 我已经在 html_theme_options 中尝试了“body_max_width”:“none”。 我还尝试过“custom.css” .wy-nav-cont...

回答 1 投票 0

Sphinx 装饰类未记录

我正在使用 Sphinx 记录我的库。我有装饰器logic_object: 类逻辑对象: """逻辑对象类的装饰器。 ”“” def __init__(self, cls): self.cls = cls ...

回答 1 投票 0

使用Python3.11 Sphinx 7.2.6生成的HTMLHELP文件无法使用hhc.exe编译

我们的软件使用Sphinx来生成文档、网站、chm等... 我们正在尝试从 python2.7 切换到 python3.11 阻塞点之一如下: 我们运行 sphinx -b htmlhelp...

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.