python-sphinx 相关问题

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

我有一个类似这样的模块： #!/usr/bin/env python #：文档在这里。＃：等等等等等等 foobar = r'这里有一些很长的正则表达式。' def myfunc(val=foobar): '''巴拉巴拉巴拉...

python documentation python-sphinx autodoc

回答 1 投票 0

这个问题试图扩展 Jason S 的代码（谢谢，Jason），可以在这里找到：Docutils: traversesections?。原文出自 Jason S 导入文档 def doctree_resolved（应用程序，文档树，文档名）...

python python-sphinx restructuredtext docutils

回答 1 投票 0

是否可以从 Jupyter Book 设置 Sphinx autodoc 模块路径？

是否可以从 Jupyter Book 设置 Sphinx autodoc Python 模块路径，例如通过 _config.yml？我正在使用 Jupyter Book 来记录 Python 系统并发布到“阅读文档”。我可以看到...

python python-sphinx autodoc jupyterbook

回答 1 投票 0

Sphinx 不会为标题生成侧边栏目录

我正在努力处理 Sphinx 生成的文档中的侧边栏目录。我只想在文档的左侧有一种自动生成的索引树。相反，我看到

python python-sphinx sidebar tableofcontents toctree

回答 3 投票 0

Sphinx 侧边栏目录：包括部分标题

我在 Sphinx 中使用 Alabaster 主题。侧边栏设置为显示本地目录和其他一些内容。来自conf.py： html_sidebars = { '**'：[ 'localtoc.html', '

python-sphinx sidebar tableofcontents

回答 1 投票 0

禁用单个 Sphinx 警告消息

我的 Sphinx 树中有许多 .rst 文件，这些文件被有意从任何索引树中排除。我收到类似警告 /filename.rst:: 警告：文档不包含在任何目录树中我怎样才能支持...

python-sphinx toctree

回答 2 投票 0

RST Sphinx xml 自定义扩展

我试图了解如何创建自定义 Sphinx 扩展，该扩展只能在创建 XML 时执行。我想放置一个自定义 RST 指令 ..我的定制:: 并输出后续的 XM...

xml python-sphinx restructuredtext

回答 1 投票 0

如何在自定义 python-sphinx 指令/扩展中使用现有指令？

我想创建一个自定义指令，在其实现中使用现有指令（本例中的代码块）。 reStructuredText 中的手动等效项是： ..我的目录...

python python-sphinx docutils

回答 2 投票 0

Sphinx 角色和指令在笔记本文本块中不起作用

我正在使用 sphinx 为一个项目创建文档，其中包含一组我正在使用 sphinx-gallery 运行的示例，但是在生成的 html 文件、sphinx 角色和指令中（例如 :class:、:meth...

python jupyter-notebook python-sphinx restructuredtext nbsphinx

回答 1 投票 0

autodoc_pydantic：如果父模型和子模型位于不同文件中，则显示父模型中的字段

这个问题存在一个答案，如何在子类中显示父母属性。然而它对我不起作用，因为我的父类和子类位于不同的文件中： ..当前模块...

python documentation python-sphinx pydantic autodoc

回答 1 投票 0

使用感叹号禁止交叉引用超链接

在链接前加上 !禁止创建引用（例如 :ref:`!no link` 将简单地呈现为无链接）：如果您在内容中添加前缀 !，则不会创建任何参考/超链接...

python-sphinx cross-reference docutils

回答 2 投票 0

使用 Sphinx 记录包 __init__ 导入

我有一个Python包，感觉它有一个方法：从伐木.src.email 导入 send_email 根据 Pandas 如何处理需要导入的内容（例如，felling.__init__.py 中的 pandas.DataFrame），我有： # 铁...

python pandas python-sphinx autodoc

回答 2 投票 0

“很棒的狮身人面像主题”中不需要的段落符号

我刚刚开始研究 Sphinx 文档，并且正在使用“很棒的 Sphinx 主题”。我只是碰巧意识到

python-sphinx

回答 1 投票 0

在评论中链接到另一个Python文件

我正在尝试从 file_1.py 创建到 file2.py 的链接。为了简单起见，我们可以假设两者都在同一个包中。我在 Java 中（通过 Intellij）要做的是使用 {@link AnotherClass} 但这是......

python visual-studio-code intellij-idea pycharm python-sphinx

回答 2 投票 0

如何在 sphinx_rtd_theme 中将“查看页面源代码”替换为“在 GitHub 上编辑”链接？

在使用 sphinx_rtd_theme 主题构建 Sphinx 网站时，如何将文档页面顶部的“查看页面源代码”超链接替换为“在 GitHub 上编辑”链接？我正在手动构建一个 readthe...

github github-pages python-sphinx read-the-docs

回答 1 投票 0

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

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

sympy python-sphinx

回答 1 投票 0

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

在 Sphinx（ReStructuredText 发布系统）中，是否有任何晦涩的规则限制文字块可以包含的内容？背景：我的文档包含许多跟随双

python-sphinx restructuredtext

回答 2 投票 0

reStructuredText/Sphinx 中的引用

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

python-sphinx restructuredtext

回答 1 投票 0

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

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

python-sphinx python-typing

回答 3 投票 0

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

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

python-sphinx myst

回答 1 投票 0

python-sphinx 相关问题

最新问题