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. 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 files for lfdocs-conf 0.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| lfdocs_conf-0.11.0.tar.gz | 41.2 kB | With provenance | Details for lfdocs_conf-0.11.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| lfdocs_conf-0.11.0-py3-none-any.whl | Python 3 | none | any | Details for lfdocs_conf-0.11.0-py3-none-any.whl |
Total release size: 53.3 kB
Release files / lfdocs_conf-0.11.0.tar.gz
| Download URL | lfdocs_conf-0.11.0.tar.gz |
|---|---|
| Size | 41.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
04178b2c249c1c1588264fa7de88fb92c82d8d6062f783f99119d78c5588b971
|
|
BLAKE2b-256 checksum How to use checksums |
46348e2f760a6cfcab7e8cdf08f95d67eb878bcc35e618675058d2d57c22e0ee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 2, 2026.
Transparency logRelease files / lfdocs_conf-0.11.0-py3-none-any.whl
| Download URL | lfdocs_conf-0.11.0-py3-none-any.whl |
|---|---|
| Size | 12.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3ce3519d9bad796b63410cf324d73fc16c54da4f8ca1a120979ecd59115796e5
|
|
BLAKE2b-256 checksum How to use checksums |
c7f1dc2f4971859bf12f42ff01d99617f6ba155a5e3db327e6c0ec48d85856a4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.2.0 CPython/3.12.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 2, 2026.
Transparency logSecurity for lfdocs-conf 0.11.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for lfdocs_conf-0.11.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 2, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
