Sphinx是一种工具,可以轻松创建智能和漂亮的文档。 Sphinx特别适用于Python文档,但它是一个通用工具,可用于记录任何内容。
主题错误:找不到名为“furo”的主题(缺少 theme.conf?)
我想先声明一下,我是 Sphinx 文档的初学者。 话虽这么说,我在尝试解决此问题时遇到了巨大的困难。 我正在尝试使用“furo&...
readthedocs 找不到requirements.txt
.readthedocs.yaml: Python: 安装: - 要求:source/requirements.txt 在文档目录中 来源 ├── _静态 ├── _模板 ├──conf.py ├── 硬件.rst ├── 索引.rst...
我正在尝试复制 PyData 文档中使用的字体。自定义 CSS 样式直接取自他们的网站,但是,我的标题以不同的字体呈现。 PyData 的文档使用 S...
所以我尝试修复现有项目中的警告,其中包含license.rst: 执照 ======= .. 包括:: ../LICENSE.txt 其中 LICENSE.txt 具有以下结构: 版权... ...提供...
我有这个带有数学指令的文档字符串,它有一个很长的锚点指向同一页面: 我的班级: r"""介绍文本。 .. 数学:: \href{#the_very_long_anc...
我正在使用: Sphinx v8.1.3 旁边的“sphinx_rtd_theme” 我不会在任何地方托管此文档 通常(使用 python 2.7 的早期 sphinx 版本)sphinx 显示“版本”...
我正在使用: Sphinx v8.1.3 旁边的“sphinx_rtd_theme” 我不会在任何地方托管此文档 通常(使用 python 2.7 的早期 sphinx 版本)sphinx 显示“版本”...
我一直有这个问题,我想写一个这样的文档字符串: def foo(arg): '''将 ``arg`` 添加到 :class:`foo.bar.baz.Argument` 列表中。''' 经过 然而,这不起作用,...
我一直有这个问题,我想写一个这样的文档字符串: def foo(arg): '''将 ``arg`` 添加到 :class:`foo.bar.baz.Argument` 列表中。''' 经过 然而,这不起作用,...
将 Sphinx autodoc-skip-member 连接到我的函数
我想使用sphinx的autodoc-skip-member事件来选择某个python类上的部分成员用于文档。 但 sphinx 文档并不清楚,我找不到任何例子......
如何让 Sphinx 在参数描述旁边而不是在函数签名上显示 Python 3 键入类型提示?
我正在使用 Sphinx(制作 HTML)从其函数的 reStructuredText 文档字符串自动生成 Python 3 模块的 HTML 文档。生成的 HTML 文档看起来不错...
如何制作 Sphinx 的 ReadTheDocs 主题,以便在移动设备上很好地布局函数参数?
Sphinx 的 ReadTheDocs 主题是一个特别漂亮且易于阅读的主题。它在宽度合适的显示器上工作得很好。这是一个例子: 它在非常狭窄的情况下也能很好地工作
我想弄清楚是否有办法嵌套 Sphinx 扩展指令。我有一些运行良好的自定义节点类型,但我希望我生成的 HTML 具有更多的灵活性...
为什么我的 sphinx-apidoc --templatedir 选项没有按预期工作?
我试图自定义./docs/conf.py以使文档管理更容易,所以我执行了以下命令: sphinx-apidoc -F -o "./docs" --templatedir=./templates "." 我
我使用 sphinx w/ MyST-Parser 进行降价,并且 我想要 GitHub 或 GitLab 风格的自动链接 (linkfying) 作为参考。 有没有办法让 MyST 渲染参考: 第346章 用文档来说,这...
使用 Sphinx 生成文档时 Flask 会抛出 KeyError
我在 docker 中有一个 python Flask 脚本。该脚本通过以下方式从 docker-compose 获取一些环境变量: 应用程序=烧瓶(__名称__) DEFAULT_PSW = os.environ['DEFAULT_PSW'] @app.route(&
我在 docker 中有一个 python Flask 脚本。该脚本通过以下方式从 docker-compose 获取一些环境变量: 应用程序=烧瓶(__名称__) DEFAULT_PSW = os.environ['DEFAULT_PSW'] @app.rou...
我正在用Python开发一个具有数百个函数的项目。其中很多都有一个称为详细程度的参数,我对其进行了如下描述: ”“” 详细程度:int,可选 ...
sphinx.ext.autodoc:外部包的 ModuleNotFoundError
我想开始使用 Sphinx 记录我的基于 Flask 的应用程序。目前,我正在尝试弄清楚如何使用 autodoc 扩展。我的本地模块都找到了,但是外部的导入
注意:我之前曾问过这个问题,但因为我放弃了该项目而删除了它,但现在我实际上需要找出如何解决。 我正在尝试制作 Sphinx 主题,但我无法让 Sphinx 检测到...