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
File details
Details for the file sphinxcontrib.constdata-1.0.11.tar.gz
.
File metadata
- Download URL: sphinxcontrib.constdata-1.0.11.tar.gz
- Upload date:
- Size: 69.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
e58fe84ce896250a3f3c8587c3e473a9cd5a5365987b125110eabf2c33c78bcb
|
|
MD5 |
b2d14e9f3900fc625362478c7962de93
|
|
BLAKE2b-256 |
16c946eebafd1cc30d880d6a55a2da3da74e8f97c7286e71d7e3ad24db017ec4
|
File details
Details for the file sphinxcontrib.constdata-1.0.11-py3-none-any.whl
.
File metadata
- Download URL: sphinxcontrib.constdata-1.0.11-py3-none-any.whl
- Upload date:
- Size: 23.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
0fec5118c7eaacfdff179d00c6d49a583647edec1b7a149cfa72b82dc25b6e83
|
|
MD5 |
e47928689d7e33f92cd86219620ef8e4
|
|
BLAKE2b-256 |
04a136ca4fc75587cd15652d033bd83dd272a0274e104d5efbbb18e05790e243
|