配置文件概述
配置文件的位置。 要放入配置文件中的内容。 如何自定义项目的配置。
阅读文档教程 . 遵循本教程中的步骤将帮助您设置第一个文档项目。
配置文件的位置
模板入门
1 #阅读Sphinx项目的Docs配置文件
2 #请参见 https://docs.readthedocs.io/en/stable/config-file/v2.html 有关详细信息
三
4 #必需
5 版本 : 2
6
7 #设置您可能需要的操作系统、Python版本和其他工具
8 建造 :
9 操作系统 : ubuntu-22.04号机组
10 工具 :
11 蟒蛇 : “3.12”
12 #还可以指定其他工具版本：
13 #nodejs:“20”
14 #锈蚀：“1.70”
15 #戈朗：“1.20”
16
17 #使用Sphinx在“docs/”目录中构建文档
18 狮身人面像 :
19 配置 : 文档/conf.py
20 #您可以将Sphinx配置为使用不同的构建器，例如，对更简单的URL使用dirhtml构建器
21 #构建器：“dirhtml”
22 #出现所有警告时失败，以避免断开引用
23 #fail_on_warning：真
24
25 #可以选择以其他格式（如PDF和ePub）构建文档
26 #格式：
27 #-pdf格式
28 #-epub（epub）
29
30 #可选但建议声明所需的Python需求
31 #构建文档
32 #请参见 https://docs.readthedocs.io/en/stable/guides/replicable-builds.html
33 #巨蟒：
34 #安装：
35 #-要求：docs/requirements.txt
1 #阅读MkDocs项目的Docs配置文件
2 #请参见 https://docs.readthedocs.io/en/stable/config-file/v2.html 有关详细信息
三
4 #必需
5 版本 : 2
6
7 #设置您可能需要的Python和其他工具的版本
8 建造 :
9 操作系统 : ubuntu-22.04号机组
10 工具 :
11 蟒蛇 : “3.12”
12
13 mkdocs公司 :
14 配置 : mkdocs.yml文件
15
16 #可以选择声明构建文档所需的Python需求
17 蟒蛇 :
18 安装 :
19 - 要求 : docs/requirements.txt文件
编辑模板
跳过：文件头和注释
评论 我们添加了注释来解释配置选项和可选功能。 这些行以 # . 已注释的功能 我们使用 # 在一些流行的配置选项之前。 它们是作为例子存在的， 您可以选择启用、删除或保存以备以后使用。 版本 钥匙 版本密钥告诉系统如何读取配置文件的其余部分。 当前且唯一受支持的版本是 版本2 .
调整： 内置.os
内置.os 具有所有可能值的配置文件引用 内置.os .
调整：Python配置
使用 python.install.path（安装路径） 使用pip将项目本身安装为Python包 使用 python.install.要求 从需求文件安装软件包 使用 构建作业 使用Poetry或PDM安装软件包
构建工具.python 所有Python版本的配置文件参考 构建工具.python . 蟒蛇 配置激活的Python环境的配置文件参考 构建工具.python .
调整：狮身人面像和MkDocs版本
使用Python依赖项的需求文件 本指南解释了如何指定Python需求， 例如斯芬克斯或MkDocs的版本。 狮身人面像 配置Sphinx构建器的配置文件参考。 mkdocs公司 用于配置MkDocs构建器的配置文件参考。