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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01c7e0b74d1b503629e2f9e8c50dc043cbbc10de6a7d47a407d4aa69889e5fb9 |
|
MD5 | 9aa9e35badaa3af6fad36eef88ae28ec |
|
BLAKE2b-256 | abcdecd80dceecd42fbd118f93e4520399b0aa0796937ec96d746331b1c70772 |
Hashes for sphinxcontrib_constdata-1.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 916873962d5ba002eeea54e9a39740223bfd6049ccc4fd05d5d31cc2ae7e0ac6 |
|
MD5 | d503e4a42ebed046ad46476ad430fa09 |
|
BLAKE2b-256 | 9ef085ad5daa51c7a928eee5f16c1a559b5ba2660decceaa3435ac1ecad550a1 |