LF Docs Config

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. Conf.py should contain at minimum:

from docs_conf import *

The conf.yaml file should contain at minimum:

---
project_cfg=myproject

If defaults for ‘myproject’ exist, they will be loaded from this package, otherwise the basic Sphinx defaults will be set.

Configuration precedence for configuration is as follows:

conf.py structure and documentation:: http://www.sphinx-doc.org/en/stable/config.html

TODO

[ ] Define the minimum 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.

Each config needs to be imported gracefully (if it doesn’t exist, set None or something; similar to 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. The documentation already is organized
by section, so 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.

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for lfdocs-conf 0.4.0
File	Size	Uploaded
lfdocs_conf-0.4.0.tar.gz	14.1 kB	Jan 29, 2020	Details

Table of built distributions (wheels) for lfdocs-conf 0.4.0
File	Interpreter	ABI	Platform	Reset
lfdocs_conf-0.4.0-py2.py3-none-any.whl 8.1 kB Jan 29, 2020	Python 2, Python 3	none	any	Details

Total release size: 22.1 kB

Download URL	lfdocs_conf-0.4.0.tar.gz
Size	14.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`c48738d847d57f2d041f2a7e3f274a5bdbd671703a98487077fa351f9bc897eb`
BLAKE2b-256 checksum How to use checksums	`853f219922d5b0af64ab094145b65dab4c71640543eaedc0efa9d03b7a2b6291`
Upload date	Jan 29, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.5`

Download URL	lfdocs_conf-0.4.0-py2.py3-none-any.whl
Size	8.1 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`9872bae32527530858dc408b2e16162846031a31f8736d8f4e18b01f89437aa2`
BLAKE2b-256 checksum How to use checksums	`1ba4ae24fed8ad14306eb7823fb3bb717c2086437edfa473ccb2cf413cc23cc5`
Upload date	Jan 29, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.5`