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:
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 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.
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
Built Distribution
File details
Details for the file lfdocs_conf-0.9.0.tar.gz.
File metadata
- Download URL: lfdocs_conf-0.9.0.tar.gz
- Upload date:
- Size: 25.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 257db5f7da6cec223ca227dc4ce98e49868691e96956c694500afc7299b28849 |
|
| MD5 | c302a6ee0e3f4bf509210943652635b7 |
|
| BLAKE2b-256 | 8dc11f9615a074d33c4d3ee8fdfcd635a65e3cbad9cb43b23a8932c00b6fcc42 |
File details
Details for the file lfdocs_conf-0.9.0-py2.py3-none-any.whl.
File metadata
- Download URL: lfdocs_conf-0.9.0-py2.py3-none-any.whl
- Upload date:
- Size: 8.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3c1ed9fdae9abb59da1c2440f03a4c986a872ea470a0610f539eedddcffddf53 |
|
| MD5 | c2e7dce9fed67065e6c7a3fba635c77e |
|
| BLAKE2b-256 | 6d492cd4499428898c1a87a73e3e5af0acc500eb3b3f3306c93ae83a5f2fe183 |
