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 conf.py. The minimal configuration for conf.py is:

from docs_conf import *

The minimal configuration for conf.yaml file is:

---
project_cfg=myproject

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/conf.py

  2. project/conf.yaml

  3. docs_conf/defaults/{project_cfg}.yaml

  4. docs_conf/defaults/default.yaml

  5. docs_conf/__init__.py

conf.py structure and documentation:

http://www.sphinx-doc.org/en/stable/config.html

TODO

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

    These can probably come from ODL/OPNFV site conf.py 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.

    Sections:

    • 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.

Source Distribution

lfdocs_conf-0.7.5.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

lfdocs_conf-0.7.5-py2.py3-none-any.whl (8.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file lfdocs_conf-0.7.5.tar.gz.

File metadata

  • Download URL: lfdocs_conf-0.7.5.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.3 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6

File hashes

Hashes for lfdocs_conf-0.7.5.tar.gz
Algorithm Hash digest
SHA256 66214b63d9050397e6a01dd46f03cd3f16ae6833805d5f83146b050ece47689b
MD5 7fce759892b992ca40765893be65baed
BLAKE2b-256 42b4ac97f420e71c5eb5fd3fe91fe32e663479c21d999be730e4dacfff2d8ea7

See more details on using hashes here.

File details

Details for the file lfdocs_conf-0.7.5-py2.py3-none-any.whl.

File metadata

  • Download URL: lfdocs_conf-0.7.5-py2.py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.1.3 requests-toolbelt/0.9.1 tqdm/4.62.1 CPython/3.9.6

File hashes

Hashes for lfdocs_conf-0.7.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 cc272e32851f9e83d58cb8acffaf964b88e550807b2d505001dcf5e9209a8cce
MD5 f026d47f8f1ade99ab7de8157b06a99f
BLAKE2b-256 e06e0f529c620e6295672db84d25c88d700130bfee4b6e756aa2c9f42d063842

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page