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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2dac206bb621465276f159b87197feb44724efc4a383faf19008bcaa3fc1cf47 |
|
MD5 | c750378a773cbafda316fb50d190b4eb |
|
BLAKE2b-256 | b2cf957c541e83952fe141a96834339a0acb75b6c50c4e3981e538cb68206002 |
Hashes for sphinxcontrib_constdata-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8eb2dbb877f47218357d5369d5b6c1288da01c9a5b86e6035b61795eb99f3f65 |
|
MD5 | 4b6cd32121f38bbb53072ead279c7481 |
|
BLAKE2b-256 | 4aabd7f3936463b2406fd476faaacc74acb9bd840e4a7d3e68e32ccde880d8dd |