python-sphinx 相关问题

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

如何阻止 jupyter-book 构建检查 .venv 目录中的文件

我正在使用jupyter-book。我最近从使用基于 conda 的环境切换到 uv。 uv 在顶层创建一个 .venv 目录。现在当我发出命令时 jupyter-book 构建。我可以看到...

python python-sphinx jupyterbook

回答 1 投票 0

自动 Ansible 文档如何工作？

这就是我的情况：我正在一个巨大的项目目录中编写 Ansible 剧本和角色。目前我的文档存储在 .md 文件中。但我想使用 Ansible 的文档机制...

python documentation ansible yaml python-sphinx

回答 2 投票 0

Sphinx：rST 内联文字解释为代码？

根据 Docutils，文本周围的双反引号相当于 :literal: 角色：https://docutils.sourceforge.io/docs/ref/rst/roles.html#literal 他们展示了一个例子，这些是等效的......

python-sphinx restructuredtext docutils

回答 1 投票 0

Plantuml 文件未包含在第一个文档中

首先考虑以下几点： .. uml:: ClassDiagram.puml :caption: 类图 conf.py 仅包含扩展名：扩展= [“sphinxcontrib.plantuml”] 使用 Sphinx，我构建了一个 html p...

python-sphinx plantuml

回答 1 投票 0

Sphinx 基于两个独立的 sys.path 生成文档

我有以下结构要呈现为文档索引.rst: .. 目录树:: ：最大深度：2 :caption: 功能系列功能/模块.rst .. 目录树:: ：最大深度：2 ：标题：

python python-sphinx sphinx restructuredtext sphinx-apidoc

回答 1 投票 0

Sphinx Readthedocs 主题字体很棒的集成

我知道这可能是一个非常愚蠢的问题，但我还没有在网上找到任何有关潜在解决方案的信息。我正在使用 Sphinx 1.4 和 sphinx_rtd_theme 生成一些文档...

django font-awesome python-sphinx read-the-docs

回答 5 投票 0

使用特定 url 路径进行多个 github 页面部署

我有一个项目，有一个关联的 github 页面，位于（例如）： https://myorg.github.io/my_repo_name 我还有 python 模块的文档。我希望也能部署 d...

python github github-pages python-sphinx myst

回答 1 投票 0

如何防止 Sphinx 将“对象”列为基类？

我有这门课：班级班级：经过 sphinx 生成的文档（如果重要的话，我使用了 autodoc 扩展）如下所示：类包.Class &n...

python inheritance python-sphinx

回答 5 投票 0

Sphinx：modules.rst：警告：文档不包含在任何目录树中

尝试使用 Sphinx 生成文档。第一次使用：sphinx-apidoc 然后使用：sphinx-build html 我收到了有关 module.rst 文件的警告。文件存在，html也生成了...

python python-sphinx toctree

回答 2 投票 0

Sphinx Auto-API 异常：模块“api”的相对导入级别过多 (1)

第一次在这里提问，如果我错过了一些细节，请原谅。我正在运行 sphinx auto-api 来生成文档，这在这个项目上一直有效，但现在抱怨一些 imp...

python documentation python-sphinx

回答 1 投票 0

停止 Sphinx 执行缓存的类方法属性

我正在编写一个用于与数据集交互的包，并且代码看起来像从 abc 导入 ABC、ABCMeta、抽象方法从 functools 导入缓存从 pathlib 导入路径来自瓦...

python properties python-sphinx metaclass python-3.9

回答 1 投票 0

Sphinx 文档：定义但隐藏标题/标题文本

我正在使用 Sphinx 来记录 Python 包。标题页/启动页的顶部包含带有项目徽标和文本的图形。这给出了我想要的视觉外观，但因为......

python python-sphinx html-title

回答 2 投票 0

Sphinx/rst 的 ruby 标签

我在 Sphinx 的帮助下从原始格式的文本创建 HTML 文档。我需要用假名（=单词上方的小字符）显示一些日语单词，如下所示：我愿意

html css python-sphinx restructuredtext ruby-characters

回答 2 投票 0

主题错误：找不到名为“furo”的主题（缺少 theme.conf？）

我想先声明一下，我是 Sphinx 文档的初学者。话虽这么说，我在尝试解决此问题时遇到了巨大的困难。我正在尝试使用“furo&...

markdown themes documentation python-sphinx restructuredtext

回答 1 投票 0

readthedocs 找不到requirements.txt

.readthedocs.yaml： Python：安装： - 要求：source/requirements.txt 在文档目录中来源 ├── _静态 ├── _模板 ├──conf.py ├── 硬件.rst ├── 索引.rst...

python pip python-sphinx read-the-docs

回答 1 投票 0

无法复制 PyData 字体

我正在尝试复制 PyData 文档中使用的字体。自定义 CSS 样式直接取自他们的网站，但是，我的标题以不同的字体呈现。 PyData 的文档使用 S...

python html css fonts python-sphinx

回答 1 投票 0

sphinx可以抑制“意外缩进”错误吗？

所以我尝试修复现有项目中的警告，其中包含license.rst：执照 ======= .. 包括:: ../LICENSE.txt 其中 LICENSE.txt 具有以下结构：版权... ...提供...

python python-sphinx restructuredtext

回答 1 投票 0

在文档字符串中用 MathJax 替换宏 URL 锚点

我有这个带有数学指令的文档字符串，它有一个很长的锚点指向同一页面：我的班级： r"""介绍文本。 .. 数学:: \href{#the_very_long_anc...

python python-sphinx line-breaks mathjax docstring

回答 1 投票 0

Sphinx 版本未显示阅读文档主题

我正在使用： Sphinx v8.1.3 旁边的“sphinx_rtd_theme” 我不会在任何地方托管此文档通常（使用 python 2.7 的早期 sphinx 版本）sphinx 显示“版本”...

python version python-sphinx

回答 1 投票 0

Sphinx 未显示版本

我正在使用： Sphinx v8.1.3 旁边的“sphinx_rtd_theme” 我不会在任何地方托管此文档通常（使用 python 2.7 的早期 sphinx 版本）sphinx 显示“版本”...

python version python-sphinx display sphinx

回答 1 投票 0

python-sphinx 相关问题

最新问题