Skip to main content

Linux Foundation DocsConf

Project description

The purpose of this project is to allow LF projects a centralized location for storing common project configuration.

To use this a project should create a conf.yaml file in the same directory as their The minimal configuration for is:

from docs_conf import *

The minimal configuration for conf.yaml file is:


Docs will load default configuration for ‘myproject’ from this package if it exists, otherwise it will load basic configuration from Sphinx defaults.

Configuration precedence for configuration is as follows:

  1. project/
  2. project/conf.yaml
  3. docs_conf/defaults/{project_cfg}.yaml
  4. docs_conf/defaults/default.yaml
  5. docs_conf/ structure and documentation:


  • [ ] Define the minimal set of config values to release initial version.

    These can probably come from ODL/OPNFV site files.

  • [ ] Use sane defaults, and don’t error out if something is not set.

    We must import each config cleanly (if it doesn’t exist, set None or something; like the function dict.get()).

  • [ ] Create own documentation for project detailing use of ‘conf.cfg’

    file as some values will require subkeys given that they’re dictionaries or expect a list of tuples.

  • [ ] Setup and document section. With the documentation organized by section,

    the config should also contain these section and look for their values under them.


    • general (aka sphinx)
    • project
    • i18n
    • html_output
    • apple_help
    • epub_output
    • latex_output
    • text_output
    • manpage_output
    • texinfo_output
    • linkcheck
    • xml
    • cplusplus
  • [ ] Configure pre-plugin sections, and reference by plugin listing.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for lfdocs-conf, version 0.7.0
Filename, size File type Python version Upload date Hashes
Filename, size lfdocs_conf-0.7.0-py2.py3-none-any.whl (8.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size lfdocs_conf-0.7.0.tar.gz (15.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page