Sphinx extension that allows showing values, tables, and links from CSV files. Instead of hard-coding values in the text, you write constants or queries replaced with value(s) from the CSV file. If the file contains language-depending strings, they can be translated with the rest of the Sphinx docs.
Project description
sphinxcontrib-constdata
sphinxcontrib-constdata is the extension for Sphinx documentation projects that allows showing values, listing tables, and generating links from CSV, JSON and YAML files. Instead of hard-coding values in the text, you write constants or queries replaced with value(s) from the external file(s). If the file contains language-sensitive strings, they can be translated with the rest of the Sphinx docs.
code: https://gitlab.com/documatt/sphinxcontrib-constdata where issues and contributions are welcome
About
sphinxcontrib-constdata started from the urge to manage thousands of external strings like UI labels, keyboard shortcuts, etc., used in a large enterprise application’s docs. Devs and translators often change these strings. Idea of hard-coding these strings in the docs, and manually watching changes and updating them across the docs, scared me so much that I developed this Sphinx extension.
Impressum
sphinxcontrib-constdata is open source licensed under BSD3.
Project logo and icon “table-multiple” provided by materialdesignicons.com.
Project details
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
Hashes for sphinxcontrib-constdata-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e80f6b95179fbd44075de9f64290ea9c8a49bce00841579d125dff89c60efec |
|
MD5 | 469888d38f577b445c83912d73392780 |
|
BLAKE2b-256 | 6c70a0c997ab8cc8d18712cd87bfcc9a0eac9aae93f70b38317dac966bba29c4 |
Hashes for sphinxcontrib_constdata-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 32328c2fddbd613ffecbab8d108b48b66bdba83738d3d19cfc77d1324b80d4df |
|
MD5 | 431bf4951a375f90f163965a810ca1ec |
|
BLAKE2b-256 | d4a2ed7284b57b8a264e27f73dc57456f2540607ad07b08384048eba25c75178 |