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. 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:
project/conf.py
project/conf.yaml
docs_conf/defaults/{project_cfg}.yaml
docs_conf/defaults/default.yaml
docs_conf/__init__.py
- conf.py structure and documentation:
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file lfdocs_conf-0.3.2.dev1.tar.gz.
File metadata
- Download URL: lfdocs_conf-0.3.2.dev1.tar.gz
- Upload date:
- Size: 13.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.1.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.6.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3501f2646238521b81f8bb3848b2204dfb78638b0a95212e222f8eb6a9304b9c |
|
| MD5 | cb418f538fa221b8a6c281edf56a0d32 |
|
| BLAKE2b-256 | 10d3344e2425de961506dc9803a868cb482daaac9102a400159b4c1f949abc96 |
