sphinxcontrib.constdata 1.0.1

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.

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.

• docs: https://documatt.gitlab.io/sphinxcontrib-constdata

• 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.

Tip

You can read about my other Sphinx documentation tools and tech writing tips, tricks, and insights at Tech writer at work blog.

Impressum

sphinxcontrib-constdata is open source licensed under BSD3.

Project logo and icon “table-multiple” provided by materialdesignicons.com.