python-sphinx 相关问题

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

Sphinx 递归自动摘要不导入模块

我对 Sphinx 的递归自动摘要感到疯狂。我的工作目录是：我的_wd | |-- 文档 | |-- 来源 | |--index.md | |--conf.py | |-- _模板 | |-- 自定义模块-

python python-sphinx read-the-docs autosummary

回答 1 投票 0

如何在 GitHub Pages 上托管 Sphinx 文档？

我最近编写了一个Python包并使用Sphinx生成了一些文档。我将文档添加到项目的 GitHub 存储库中，现在想要托管静态页面。我在网上读到...

github github-pages python-sphinx python-packaging

回答 2 投票 0

固定侧边栏内的狮身人面像雪花石膏主题滚动

我制作了一个sphinx项目/文档（使用雪花石膏主题），其左侧有一个固定的侧边栏（包含目录），但屏幕上显示的内容太多。我怎样才能...

html css scroll python-sphinx

回答 2 投票 0

Sphinx Read-The-Docs 主题已识别但未“找到”

我从 Github 下载了 sphinx 的 read-the-docs 主题并将其放入 _themes 文件夹中。 conf.py： html_主题=“sphinx_rtd_主题” html_theme_path = [“_主题”，] 然而，

themes python-sphinx read-the-docs

回答 5 投票 0

Sphinx 文档 toctree 单击“跳转”到导航锚点而不是顶部

当我单击目录树（导航栏）项目时，页面“跳转/摇动”到目录元素，而不是新页面的顶部，就好像它与目录树锚点对齐（而不是正文 h1 或 j.. .

python python-sphinx restructuredtext

回答 1 投票 0

Sphinx 中带有 ␣ 符号的 MathJax 渲染问题

我正在使用 Sphinx 构建文档。我的第一个文件中有以下内容： .. 数学：： {{a^{{p_1}{p_2}}_{{p_3}{p_4}}}{a^{␣\,{p_5}}_{{p_6}{p_7}}}} 在构建时，这会产生“数学输入

python-sphinx mathjax restructuredtext

回答 1 投票 0

如何防止Sphinx在使用槽时在类文档中显示重复的属性？

我正在使用 Sphinx 为 Python 项目生成文档，并且我注意到某些属性在类文档中显示了两次。这是我当前的简化设置：

python python-sphinx autodoc slots

回答 1 投票 0

sphinx文档中如何自动添加参数类型

我目前正在尝试使用Sphinx（使用扩展sphinx-apidoc和napoleon）实现自动文档创建。这工作得很好，但如果有类型提示就更好了（

python python-sphinx python-typing sphinx-napoleon sphinx-apidoc

回答 1 投票 0

禁用 numpydoc 创建的自动自动摘要

使用autodoc时是否可以禁用完整的自动摘要？我有一个派生自 Python 标准库类的类，它有许多公共方法。我的自定义类应该作为

python-sphinx autodoc numpydoc

回答 3 投票 0

sphinx 可以根据实际实施验证文档吗

我正在向几个项目添加 sphinx 文档，但我担心未来的开发人员在方法接口发生变化时不会严格更新文档......

python python-sphinx

回答 1 投票 0

MyST 隐式引用在本地工作，但不适用于阅读文档

我正在使用 Sphinx 来构建我的文档，并使用 MyST 解析 markdown 文件。我使用隐式文本链接到不同的引用，例如 [](#my-heading) 或 [](#MyPyClass)。这很好用

python hyperlink python-sphinx read-the-docs myst

回答 1 投票 0

Sphinx autoflask 仅为所有端点制作一页

我继承了一个项目，并且是第一次使用Sphinx。我有一个 app.py ，其中包含我所有的 api 端点，当您制作文档时，您将所有 api.add_resources 包装在一个 func 中...

python flask python-sphinx documentation-generation

回答 1 投票 0

无 Webhook：在 Read The Docs 上构建文档时出现问题

我目前正在尝试在 readthedocs.com 上为我的 Sphinx 重组文本项目构建文档。文档本身位于其自己的 github 存储库中。我已经添加了 webhook...

python python-sphinx read-the-docs

回答 1 投票 0

在阅读文档时使用 Sphinx 时出现 Ascii 解码错误 - 在本地可以正常工作

我开始为我的 python/django 项目编写文档。有时候是这样的：运行 Sphinx v1.2 正在加载翻译 [en]...完成构建 [readthedocs]：18 个源文件的目标...

python python-sphinx read-the-docs

回答 1 投票 0

如何用myST替代品进行超链接

我正在使用 Sphinx、Doxygen 和 CMake 构建项目文档。在我的项目中，有几个降价文件，我必须在其中超链接不同的链接。这些都有一个共同的风格

hyperlink markdown python-sphinx myst

回答 1 投票 0

如何让 Sphinx 使用 Python 存根文件中的类型注释

我使用存根文件（即“*.pyi”文件）来管理项目中的类型注释。我的文档字符串位于实际的源文件中。我已经安装了 sphinx-autodoc-annotation 来让 Sphinx 找到...

python python-sphinx python-typing stub

回答 1 投票 0

为 Sphinx 中的解释文本角色添加附加类

我想要实现的是使用sphinx的python域（手动）将html类插入到某些元素例如我有这个字符串： Lore Ipsum :py:mod:`数据类` 哪个结果...

python python-sphinx restructuredtext docutils

回答 1 投票 0

Sphinx 和 TypedDict

我在代码中定义了一个 TypedDict，如下所示：类 VectorDict(TypedDict): x：浮动 y：浮动 z：浮动当我生成文档时，我得到以下结果：怎样才能抑制

python python-sphinx python-typing

回答 1 投票 0

我们如何在 Sphinx 文档中嵌入图像？

如何在 Sphinx 文档中嵌入图像？

image python-sphinx

回答 5 投票 0

如何将代码示例嵌入到文档字符串中？

如何将代码嵌入到文档字符串中，以告诉 Sphinx 将代码格式化为与 Markdown 中类似的格式（不同的背景颜色、等宽无衬线字体）？例如记录 c...

python python-sphinx docstring

回答 2 投票 0

python-sphinx 相关问题

最新问题