Linux基金会

lfdocs-conf的Python项目详细描述


本项目的目的是让LF项目成为 存储公共项目配置。

要使用这个,一个项目应该在同一个文件中创建一个conf.yaml文件 目录作为它们的conf.py。conf.py至少应包含:

from docs_conf import *

conf.yaml文件应至少包含:

---
project_cfg=myproject

如果存在“MyPosits”的默认值,它们将从此加载 包,否则将设置基本sphinx默认值。

配置的配置优先级如下:

  1. 项目/conf.py
  2. 项目/conf.yaml
  3. docs_conf/defaults/{project_cfg}.yaml
  4. docs_conf/defaults/default.yaml
  5. 文档配置/初始化
conf.py结构和文档:
http://www.sphinx-doc.org/en/stable/config.html

待办事项

  • []定义释放初始版本的最小配置值集。

    这些文件可能来自odl/opnfv site conf.py文件。

  • []使用正常的默认值,如果没有设置,不要出错。

    需要优雅地导入每个配置(如果没有 存在,不设置任何东西;类似于

  • []为项目创建自己的文档,详细说明如何使用“conf.cfg”

    文件,因为有些值需要子键,因为它们是 字典或需要元组列表。

  • []设置和文档部分。文档已经整理好了

    按节,因此配置也应该包含这些节并查看 为了他们的价值观。

    章节:

    • general (aka sphinx)
    • project
    • i18n
    • html_output
    • apple_help
    • epub_output
    • latex_output
    • text_output
    • manpage_output
    • texinfo_output
    • linkcheck
    • xml
    • cplusplus
  • []配置插件前部分,并按插件列表引用。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java通过两个整数数组对正整数和负整数进行排序   java无参数和默认构造函数混淆   java加载文件MD5的最快方法是什么?   java如何在变量声明中使用带“e”的float   java将项目导入到STS iMac   java在使用图像时旋转图像   java Break语句不起作用   java提供了错误类型Spring的id   java如何为多个变量设置相同的函数属性?   JavaMaven:如何添加编译阶段后生成的资源   java HashMap已损坏/性能问题   java Hibernate SQL中间表b/w父表和子表(不同类型)   java PDFbox找不到字体:/Helv   Java:向自实现的双链接列表添加排序函数   为使用Java BouncyCastle生成的X509Certificate提供密钥使用的安全性   java Hibernate在读写方面的性能   C#相当于Java的DataOutputStream?