Kivy 文档构建指南从doc/README.md出发的 Sphinx 文档本地构建与 CI 流程深度解析【免费下载链接】kivyOpen source UI framework written in Python, running on Windows, Linux, macOS, Android and iOS项目地址: https://gitcode.com/gh_mirrors/ki/kivy本文基于 Kivy 仓库中的 文档构建说明展开面向希望修改、扩展或本地构建 Kivy 官方文档的开发者。读完本文你将掌握 Kivy 文档从源码安装、Sphinx 构建到本地预览的完整操作流程并能深入理解make html背后隐藏的 API 页自动生成机制autobuild.py、Sphinx 扩展定制conf.py与sphinxext/、多格式构建目标以及 CI 中文档的产出与发布链路。一、文档构建的官方入口与操作前提doc/README.md 是 Kivy 文档子系统的入口说明它定义了四条核心事实线上最新版本文档托管在 kivy.org/docs贡献者修改文档前必须确保 kivy 源码是最新版本否则过时的文档可能引发合并冲突构建文档需要先安装文档依赖pip install -e .[docs]且 Sphinx 要求 Python 3.12生成命令为make html产物位于build/html/本地预览方式为cd build/html/后运行python -m http.server 8000。这里有两个值得注意的“前提条件”它们解释了为什么文档构建与 Kivy 本身的构建强耦合Python 版本pyproject.toml 中声明requires-python 3.11并在 classifiers 中列出 Python 3.11–3.14而[tool.kivy]段给出了python_versions 3.11 - 3.14。文档 README 特别强调 Sphinx 需要 Python 3.12这是因为文档构建会import kivy并触发大量模块加载见下文因此建议使用 3.12 或更高版本。pip install -e .[docs]的含义-e表示以可编辑模式安装 Kivy 本身会触发 Cython 编译 C 扩展.[docs]则安装 pyproject.toml 中的可选依赖组。当前仓库中该依赖组非常精简[project.optional-dependencies] docs [ sphinx9.1.0 ]也就是说文档构建额外固定的只有 Sphinx 9.1.0 一个依赖其余pygments、docutils 等已经是 Kivy 的核心运行依赖。仓库中还有一个 doc/doc-requirements.txt其内容仅是一行注释 “Frozen Sphinx requirements for easier pip installation”说明历史上曾在此冻结 Sphinx 相关依赖现已被 pyproject 的 extras 取代。标准构建流程在doc/目录下执行# 1. 安装文档依赖在仓库根目录执行要求 Python 3.12 pip install -e .[docs] # 2. 生成 HTML 文档 cd doc make html # 3. 本地图文预览 cd build/html python -m http.server 8000二、doc/Makefile多格式构建目标全解Kivy 的文档构建由 doc/Makefile 驱动它是一个标准的 Sphinx Makefile 扩展。核心变量如下变量默认值作用PYTHONpython3回退到python两者都找不到时直接报错SPHINXOPTS-Q静默输出SPHINXOPTS_TEST-W -T测试模式下将警告视为错误并显示回溯ENDUSER_BUILDyes设为yes时不启用测试选项即普通make html不严格ALLSPHINXOPTS-d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sources指向源目录 doc/sources构建模式由ENDUSER_BUILD决定make html ENDUSER_BUILDno会切换到ALLSPHINXOPTS_TEST即加上-W -T严格模式——这正是维护者本地校验文档的正确姿势。Makefile 提供了完整的输出格式矩阵make help可列出build-all: html pickle htmlhelp pdf ps gettext test: build-allhtml/fasthtml生成独立 HTML 页面fasthtml额外附加-j4并行 4 进程latex→pdf/ps生成 LaTeX 文件并进一步编译为 PDFpdf目标会检查build/latex/Kivy.pdf是否存在不存在则exit 1gettext生成.po翻译文件输出到build/gettext/linkcheck校验所有引用链接pickle/web/htmlhelp/man/changes分别为 sphinx-web、HTML Help、man 页、变更概览等输出。clean目标同样重要——它清理的正是自动生成物clean: -rm -rf sources/api-*.rst -rm -rf sources/examples/gen__*.rst -rm -rf sources/examples/gallery.rst -rm -rf sources/examples/index.rst -rm -rf build/* -rm $(AUTOBUILD_STAMP)*注意sources/api-*.rst与sources/examples/gen__*.rst等文件并不存在于仓库中它们是构建时动态生成的见下一节。此外 Makefile 通过ifdef ComSpec区分 Windows 与类 Unix 平台的分隔符和mkdir语法保证make在两种平台上行为一致。三、make html的隐藏第一步API 文档自动生成这是 Kivy 文档体系最独特的部分doc/sources/conf.py 在加载时会检查doc/autobuild.py-done标记文件是否存在若不存在则立即import autobuildbase autobuild.py-done if not os.path.exists(os.path.join(os.path.dirname(base_dir), base)): import autobuild from kivy.tools import gallery gallery.write_all_rst_pages()doc/autobuild.py 是一个“从运行中的 Kivy 包逆向生成 API 参考页”的脚本其工作流程如下强制加载全部模块脚本显式import了kivy.app、kivy.metrics、kivy.core.*、kivy.graphics、kivy.modules.*、kivy.storage.*等几乎所有公共模块并通过for x in list(Factory.classes.keys()): getattr(Factory, x)强制实例化 Factory 中的全部 widget 类确保 Cython 扩展与动态工厂类都被加载扫描sys.modules收集所有以kivy开头的模块跳过 autobuild.py 顶部ignore_list中的私有模块如kivy._clock、kivy._event、kivy.graphics.buffer等生成索引与页面写出sources/api-index.rstAPI 总目录以及每个包/模块对应的sources/api-name.rst页面模板内置.. automodule::指令带:members:与:show-inheritance:并自动从模块 docstring 首行提取摘要标题关联示例代码对每个模块脚本会在examples/framework/目录中 glob 匹配同名前缀的示例.py文件将其源码以:download:指令 缩进代码块的形式内嵌到对应 API 页的 “Examples” 小节中形成“API ↔ 示例”的双向引用写入幂等writefile()在内容无变化时不重写文件脚本运行后会在doc/下创建空文件autobuild.py-done作为标记使后续 Sphinx 构建跳过重复生成——这正是 conf.py 用该标记文件做门禁、Makefile 的clean目标负责删除它的原因。BE_QUIET环境变量BE_QUIETFalse可打开生成过程的文件级日志。因此make html的真实调用链是Makefile→sphinx-build→ 执行conf.py→ 首次import autobuild生成全部api-*.rst→kivy.tools.gallery.write_all_rst_pages()生成示例画廊kivy/tools/gallery.py对应被clean清理的sources/examples/gen__*.rst与gallery.rst→ Sphinx 渲染。这也解释了为什么文档构建必须先完成 Kivy 的 C 扩展编译autobuild 需要真正 import 运行 Kivy。四、conf.py版本注入、主题切换与 KV 高亮doc/sources/conf.py 除触发 autobuild 外还负责数项关键定制1. 从包与 pyproject 动态注入版本信息。conf.py直接import kivy并打印其__file__以确认加载位置随后把kivy.__version__赋给version与release。更巧妙的是它从 pyproject.toml 的[tool.kivy]段读取python_versions3.11 - 3.14与cython_max3.2.0构造如下替换映射并生成rst_epilogreplacements { python_versions: python_versions, kivy_version: kivy.__version__, cython_install: fCython{cython_max_version}, python_versions_bold: f**{python_versions}**, kivy_version_bold: f**{kivy.__version__}**, }由此生成的.. |name| replace:: value片段让所有 rst 页面可以用|kivy_version|、|cython_install|等替换符引用当前构建的真实版本号——文档版本信息永远不会与源码脱节。2. 双主题策略。本地构建使用html_style fresh.css与自定义pygments_style kivy_pygments_theme.KivyStyle定义于 doc/sources/sphinxext/kivy_pygments_theme.py而检测到READTHEDOCSTrue环境变量时切换为sphinx_rtd_theme模板目录也从.templates切换为_templates。也就是说同一套源文件在本地与文档托管平台呈现两种外观。3. Issue 快捷链接。通过extlinks定义了:repo:角色指向 GitHub issue 页https://github.com/kivy/kivy/issues/%s且对 Sphinx 4 使用了#%s的 caption 占位写法以兼容新版本对 caption 的%s替换要求。4. Snippets 幻灯片轮播。conf.py底部的setup(app)在builder-inited事件触发generate_carousel()它递归收集 doc/sources/snippets_slides 目录下全部.rst幻灯片生成带 “Previous/Next” 按钮的 HTML 轮播骨架并内联 snippets_slides.js 中的切换脚本最终写出_code_snippets_slides.html供页面嵌入。这构成了文档中可交互演示代码片段的机制。5. Cython 模块的 autodoc 修正。conf.py 顶部有一个针对 Cython 类的猴子补丁sphinx.ext.autodoc.ClassDocumenter.priority 10防止 Cython 类被 autodoc 误判为属性。更深一层的修正在 doc/sources/sphinxext/preprocess.pyCythonMethodDocumenterpriority 12确保 Cython 编译出的方法优先按“方法”而非“属性”文档化is_cython_extension()通过检查__objclass__、__pyx_vtable__以及 docstring 首行的签名模式来识别 Cython 产物autodoc-process-docstring回调会剥离 Cython docstring 首行的函数签名、去公共缩进避免生成的文档出现错位autodoc-process-signature回调把 Cython 方法签名中的(self, ...)还原为 Python 风格签名其setup(app)还从 kivy/extras/highlight.py 引入KivyLexer注册为kv语言的语法高亮器——所以文档中所有.kv代码块都能正确高亮。五、本地预览与 CI 文档发布链路本地预览。文档 README 推荐的python -m http.server 8000是最小可用预览由于构建产物是纯静态 HTML含carousel等少量内联 JS静态服务器即可完整体验。需要留意的是生成的 HTML 中引用了:download:指向的原始 rst/示例文件预览时这些下载链接依赖build/html/目录内的复制产物直接双击打开个别页面时相对路径可能失效因此以 HTTP 方式从build/html/根浏览最为稳妥。CI 侧的文档产出。仓库的 CI 脚本 ubuntu_ci.sh 中定义了generate_docs()执行make构建与upload_docs_to_server()两个函数后者仅在远端存在对应的docs-branch分支时把构建产物提交并推送到独立仓库kivy-website-docs。从脚本结构看文档发布被设计成按分支灰度——只有显式创建了docs-*分支的提交才会触发文档上传避免未定稿的文档污染线上站点。六、完整操作清单与常见问题将 doc/README.md 的流程与仓库证据合并一次完整的文档构建/贡献工作流为# 前提Python 3.12Sphinx 要求仓库位于 kivy/ 根目录 # 1. 同步源码README 明确要求文档贡献前保证 kivy 源码最新 # 2. 安装编译 C 扩展 安装 sphinx9.1.0 pip install -e .[docs] # 3. 构建首次会自动运行 autobuild 生成 api-*.rst 与 examples 页面 cd doc make html # 4. 维护者严格校验警告即失败 make html ENDUSER_BUILDno # 5. 预览 cd build/html python -m http.server 8000 # 6. 清理生成物 cd .. make clean常见问题对照仓库事实的解答为什么必须pip install -e .[docs]而不是只pip install sphinx因为conf.py会import kivyautobuild.py会 import 全部 Kivy 模块并实例化 Factory 类未编译的 C 扩展会导致导入失败。为什么doc/sources/里看不到api-*.rst它们是构建期生成的被 doc/Makefile 的clean目标列入删除清单不入库以避免与源码漂移。Sphinx 版本要求当前固定sphinx9.1.0pyproject.tomlconf.py 中sphinx.version_info[0] 4的分支逻辑即为兼容该版本而写。make test的作用它等价于build-allhtml/pickle/htmlhelp/pdf/ps/gettext 全量构建Makefile 中留有# TODO: Make test run in non-enduser-build mode注释说明严格的-W -T全量校验目前仍主要服务于手动维护场景。七、小结doc/README.md 虽然简短但它锚定了 Kivy 文档体系的三大支柱以 doc/Makefile 为入口的多格式 Sphinx 构建、以 doc/autobuild.py 为核心的“API 页从活代码实时生成”机制以及以 doc/sources/conf.py doc/sources/sphinxext/ 实现的 Cython 感知 autodoc 定制。理解这条链路后你不仅能复现make html→build/html/→ 本地http.server的标准流程还能在新增 Kivy 模块时确认它会被自动收录进 API 参考、在编写.kv示例时利用已注册的高亮器并在贡献文档时用ENDUSER_BUILDno的严格模式自检确保文档与源码始终同步。【免费下载链接】kivyOpen source UI framework written in Python, running on Windows, Linux, macOS, Android and iOS项目地址: https://gitcode.com/gh_mirrors/ki/kivy创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Kivy 文档构建指南：从 `doc/README.md` 出发的 Sphinx 文档本地构建与 CI 流程深度解析
Kivy 文档构建指南从doc/README.md出发的 Sphinx 文档本地构建与 CI 流程深度解析【免费下载链接】kivyOpen source UI framework written in Python, running on Windows, Linux, macOS, Android and iOS项目地址: https://gitcode.com/gh_mirrors/ki/kivy本文基于 Kivy 仓库中的 文档构建说明展开面向希望修改、扩展或本地构建 Kivy 官方文档的开发者。读完本文你将掌握 Kivy 文档从源码安装、Sphinx 构建到本地预览的完整操作流程并能深入理解make html背后隐藏的 API 页自动生成机制autobuild.py、Sphinx 扩展定制conf.py与sphinxext/、多格式构建目标以及 CI 中文档的产出与发布链路。一、文档构建的官方入口与操作前提doc/README.md 是 Kivy 文档子系统的入口说明它定义了四条核心事实线上最新版本文档托管在 kivy.org/docs贡献者修改文档前必须确保 kivy 源码是最新版本否则过时的文档可能引发合并冲突构建文档需要先安装文档依赖pip install -e .[docs]且 Sphinx 要求 Python 3.12生成命令为make html产物位于build/html/本地预览方式为cd build/html/后运行python -m http.server 8000。这里有两个值得注意的“前提条件”它们解释了为什么文档构建与 Kivy 本身的构建强耦合Python 版本pyproject.toml 中声明requires-python 3.11并在 classifiers 中列出 Python 3.11–3.14而[tool.kivy]段给出了python_versions 3.11 - 3.14。文档 README 特别强调 Sphinx 需要 Python 3.12这是因为文档构建会import kivy并触发大量模块加载见下文因此建议使用 3.12 或更高版本。pip install -e .[docs]的含义-e表示以可编辑模式安装 Kivy 本身会触发 Cython 编译 C 扩展.[docs]则安装 pyproject.toml 中的可选依赖组。当前仓库中该依赖组非常精简[project.optional-dependencies] docs [ sphinx9.1.0 ]也就是说文档构建额外固定的只有 Sphinx 9.1.0 一个依赖其余pygments、docutils 等已经是 Kivy 的核心运行依赖。仓库中还有一个 doc/doc-requirements.txt其内容仅是一行注释 “Frozen Sphinx requirements for easier pip installation”说明历史上曾在此冻结 Sphinx 相关依赖现已被 pyproject 的 extras 取代。标准构建流程在doc/目录下执行# 1. 安装文档依赖在仓库根目录执行要求 Python 3.12 pip install -e .[docs] # 2. 生成 HTML 文档 cd doc make html # 3. 本地图文预览 cd build/html python -m http.server 8000二、doc/Makefile多格式构建目标全解Kivy 的文档构建由 doc/Makefile 驱动它是一个标准的 Sphinx Makefile 扩展。核心变量如下变量默认值作用PYTHONpython3回退到python两者都找不到时直接报错SPHINXOPTS-Q静默输出SPHINXOPTS_TEST-W -T测试模式下将警告视为错误并显示回溯ENDUSER_BUILDyes设为yes时不启用测试选项即普通make html不严格ALLSPHINXOPTS-d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sources指向源目录 doc/sources构建模式由ENDUSER_BUILD决定make html ENDUSER_BUILDno会切换到ALLSPHINXOPTS_TEST即加上-W -T严格模式——这正是维护者本地校验文档的正确姿势。Makefile 提供了完整的输出格式矩阵make help可列出build-all: html pickle htmlhelp pdf ps gettext test: build-allhtml/fasthtml生成独立 HTML 页面fasthtml额外附加-j4并行 4 进程latex→pdf/ps生成 LaTeX 文件并进一步编译为 PDFpdf目标会检查build/latex/Kivy.pdf是否存在不存在则exit 1gettext生成.po翻译文件输出到build/gettext/linkcheck校验所有引用链接pickle/web/htmlhelp/man/changes分别为 sphinx-web、HTML Help、man 页、变更概览等输出。clean目标同样重要——它清理的正是自动生成物clean: -rm -rf sources/api-*.rst -rm -rf sources/examples/gen__*.rst -rm -rf sources/examples/gallery.rst -rm -rf sources/examples/index.rst -rm -rf build/* -rm $(AUTOBUILD_STAMP)*注意sources/api-*.rst与sources/examples/gen__*.rst等文件并不存在于仓库中它们是构建时动态生成的见下一节。此外 Makefile 通过ifdef ComSpec区分 Windows 与类 Unix 平台的分隔符和mkdir语法保证make在两种平台上行为一致。三、make html的隐藏第一步API 文档自动生成这是 Kivy 文档体系最独特的部分doc/sources/conf.py 在加载时会检查doc/autobuild.py-done标记文件是否存在若不存在则立即import autobuildbase autobuild.py-done if not os.path.exists(os.path.join(os.path.dirname(base_dir), base)): import autobuild from kivy.tools import gallery gallery.write_all_rst_pages()doc/autobuild.py 是一个“从运行中的 Kivy 包逆向生成 API 参考页”的脚本其工作流程如下强制加载全部模块脚本显式import了kivy.app、kivy.metrics、kivy.core.*、kivy.graphics、kivy.modules.*、kivy.storage.*等几乎所有公共模块并通过for x in list(Factory.classes.keys()): getattr(Factory, x)强制实例化 Factory 中的全部 widget 类确保 Cython 扩展与动态工厂类都被加载扫描sys.modules收集所有以kivy开头的模块跳过 autobuild.py 顶部ignore_list中的私有模块如kivy._clock、kivy._event、kivy.graphics.buffer等生成索引与页面写出sources/api-index.rstAPI 总目录以及每个包/模块对应的sources/api-name.rst页面模板内置.. automodule::指令带:members:与:show-inheritance:并自动从模块 docstring 首行提取摘要标题关联示例代码对每个模块脚本会在examples/framework/目录中 glob 匹配同名前缀的示例.py文件将其源码以:download:指令 缩进代码块的形式内嵌到对应 API 页的 “Examples” 小节中形成“API ↔ 示例”的双向引用写入幂等writefile()在内容无变化时不重写文件脚本运行后会在doc/下创建空文件autobuild.py-done作为标记使后续 Sphinx 构建跳过重复生成——这正是 conf.py 用该标记文件做门禁、Makefile 的clean目标负责删除它的原因。BE_QUIET环境变量BE_QUIETFalse可打开生成过程的文件级日志。因此make html的真实调用链是Makefile→sphinx-build→ 执行conf.py→ 首次import autobuild生成全部api-*.rst→kivy.tools.gallery.write_all_rst_pages()生成示例画廊kivy/tools/gallery.py对应被clean清理的sources/examples/gen__*.rst与gallery.rst→ Sphinx 渲染。这也解释了为什么文档构建必须先完成 Kivy 的 C 扩展编译autobuild 需要真正 import 运行 Kivy。四、conf.py版本注入、主题切换与 KV 高亮doc/sources/conf.py 除触发 autobuild 外还负责数项关键定制1. 从包与 pyproject 动态注入版本信息。conf.py直接import kivy并打印其__file__以确认加载位置随后把kivy.__version__赋给version与release。更巧妙的是它从 pyproject.toml 的[tool.kivy]段读取python_versions3.11 - 3.14与cython_max3.2.0构造如下替换映射并生成rst_epilogreplacements { python_versions: python_versions, kivy_version: kivy.__version__, cython_install: fCython{cython_max_version}, python_versions_bold: f**{python_versions}**, kivy_version_bold: f**{kivy.__version__}**, }由此生成的.. |name| replace:: value片段让所有 rst 页面可以用|kivy_version|、|cython_install|等替换符引用当前构建的真实版本号——文档版本信息永远不会与源码脱节。2. 双主题策略。本地构建使用html_style fresh.css与自定义pygments_style kivy_pygments_theme.KivyStyle定义于 doc/sources/sphinxext/kivy_pygments_theme.py而检测到READTHEDOCSTrue环境变量时切换为sphinx_rtd_theme模板目录也从.templates切换为_templates。也就是说同一套源文件在本地与文档托管平台呈现两种外观。3. Issue 快捷链接。通过extlinks定义了:repo:角色指向 GitHub issue 页https://github.com/kivy/kivy/issues/%s且对 Sphinx 4 使用了#%s的 caption 占位写法以兼容新版本对 caption 的%s替换要求。4. Snippets 幻灯片轮播。conf.py底部的setup(app)在builder-inited事件触发generate_carousel()它递归收集 doc/sources/snippets_slides 目录下全部.rst幻灯片生成带 “Previous/Next” 按钮的 HTML 轮播骨架并内联 snippets_slides.js 中的切换脚本最终写出_code_snippets_slides.html供页面嵌入。这构成了文档中可交互演示代码片段的机制。5. Cython 模块的 autodoc 修正。conf.py 顶部有一个针对 Cython 类的猴子补丁sphinx.ext.autodoc.ClassDocumenter.priority 10防止 Cython 类被 autodoc 误判为属性。更深一层的修正在 doc/sources/sphinxext/preprocess.pyCythonMethodDocumenterpriority 12确保 Cython 编译出的方法优先按“方法”而非“属性”文档化is_cython_extension()通过检查__objclass__、__pyx_vtable__以及 docstring 首行的签名模式来识别 Cython 产物autodoc-process-docstring回调会剥离 Cython docstring 首行的函数签名、去公共缩进避免生成的文档出现错位autodoc-process-signature回调把 Cython 方法签名中的(self, ...)还原为 Python 风格签名其setup(app)还从 kivy/extras/highlight.py 引入KivyLexer注册为kv语言的语法高亮器——所以文档中所有.kv代码块都能正确高亮。五、本地预览与 CI 文档发布链路本地预览。文档 README 推荐的python -m http.server 8000是最小可用预览由于构建产物是纯静态 HTML含carousel等少量内联 JS静态服务器即可完整体验。需要留意的是生成的 HTML 中引用了:download:指向的原始 rst/示例文件预览时这些下载链接依赖build/html/目录内的复制产物直接双击打开个别页面时相对路径可能失效因此以 HTTP 方式从build/html/根浏览最为稳妥。CI 侧的文档产出。仓库的 CI 脚本 ubuntu_ci.sh 中定义了generate_docs()执行make构建与upload_docs_to_server()两个函数后者仅在远端存在对应的docs-branch分支时把构建产物提交并推送到独立仓库kivy-website-docs。从脚本结构看文档发布被设计成按分支灰度——只有显式创建了docs-*分支的提交才会触发文档上传避免未定稿的文档污染线上站点。六、完整操作清单与常见问题将 doc/README.md 的流程与仓库证据合并一次完整的文档构建/贡献工作流为# 前提Python 3.12Sphinx 要求仓库位于 kivy/ 根目录 # 1. 同步源码README 明确要求文档贡献前保证 kivy 源码最新 # 2. 安装编译 C 扩展 安装 sphinx9.1.0 pip install -e .[docs] # 3. 构建首次会自动运行 autobuild 生成 api-*.rst 与 examples 页面 cd doc make html # 4. 维护者严格校验警告即失败 make html ENDUSER_BUILDno # 5. 预览 cd build/html python -m http.server 8000 # 6. 清理生成物 cd .. make clean常见问题对照仓库事实的解答为什么必须pip install -e .[docs]而不是只pip install sphinx因为conf.py会import kivyautobuild.py会 import 全部 Kivy 模块并实例化 Factory 类未编译的 C 扩展会导致导入失败。为什么doc/sources/里看不到api-*.rst它们是构建期生成的被 doc/Makefile 的clean目标列入删除清单不入库以避免与源码漂移。Sphinx 版本要求当前固定sphinx9.1.0pyproject.tomlconf.py 中sphinx.version_info[0] 4的分支逻辑即为兼容该版本而写。make test的作用它等价于build-allhtml/pickle/htmlhelp/pdf/ps/gettext 全量构建Makefile 中留有# TODO: Make test run in non-enduser-build mode注释说明严格的-W -T全量校验目前仍主要服务于手动维护场景。七、小结doc/README.md 虽然简短但它锚定了 Kivy 文档体系的三大支柱以 doc/Makefile 为入口的多格式 Sphinx 构建、以 doc/autobuild.py 为核心的“API 页从活代码实时生成”机制以及以 doc/sources/conf.py doc/sources/sphinxext/ 实现的 Cython 感知 autodoc 定制。理解这条链路后你不仅能复现make html→build/html/→ 本地http.server的标准流程还能在新增 Kivy 模块时确认它会被自动收录进 API 参考、在编写.kv示例时利用已注册的高亮器并在贡献文档时用ENDUSER_BUILDno的严格模式自检确保文档与源码始终同步。【免费下载链接】kivyOpen source UI framework written in Python, running on Windows, Linux, macOS, Android and iOS项目地址: https://gitcode.com/gh_mirrors/ki/kivy创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考