Linux Foundation DocsConf
项目描述
该项目的目的是允许 LF 项目在集中位置存储常见项目配置。
要使用此功能，项目应在与 conf.py 相同的目录中创建一个 conf.yaml 文件。conf.py 的最小配置如下
from docs_conf import *
conf.yaml 文件的最小配置如下
--- project_cfg=myproject
如果存在，文档将从该包加载 'myproject' 的默认配置，否则将加载 Sphinx 默认的基本配置。
配置的优先级如下
project/conf.py
project/conf.yaml
docs_conf/defaults/{project_cfg}.yaml
docs_conf/defaults/default.yaml
docs_conf/__init__.py
- conf.py 结构和文档
待办事项
- [ ] 定义发布初始版本所需的最小配置值。
这些值可能来自ODL/OPNFV站点的conf.py文件。
- [ ] 使用合理的默认值，如果某些设置未设置，则不要出错。
我们必须干净地导入每个配置（如果不存在，则设置None或类似；如dict.get()函数）。
- [ ] 为项目创建自己的文档，详细说明“conf.cfg”文件的使用
，因为某些值需要子键，因为它们是字典或期望元组列表。
- [ ] 设置和记录部分。通过按部分组织文档，
配置也应该包含这些部分，并在其下查找它们的值。
部分
通用（即sphinx）
项目
国际化
HTML输出
苹果帮助
EPUB输出
LaTeX输出
文本输出
手册页输出
TeXinfo输出
链接检查
XML
C++
[ ] 配置预插件部分，并通过插件列表引用。
项目详情
关闭
lfdocs_conf-0.9.0.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 257db5f7da6cec223ca227dc4ce98e49868691e96956c694500afc7299b28849 |
|
| MD5 | c302a6ee0e3f4bf509210943652635b7 |
|
| BLAKE2b-256 | 8dc11f9615a074d33c4d3ee8fdfcd635a65e3cbad9cb43b23a8932c00b6fcc42 |
关闭
lfdocs_conf-0.9.0-py2.py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 3c1ed9fdae9abb59da1c2440f03a4c986a872ea470a0610f539eedddcffddf53 |
|
| MD5 | c2e7dce9fed67065e6c7a3fba635c77e |
|
| BLAKE2b-256 | 6d492cd4499428898c1a87a73e3e5af0acc500eb3b3f3306c93ae83a5f2fe183 |
