Metadata-Version: 2.1
Name: sphinxcontrib-constdata
Version: 1.0.5
Summary: 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.
Home-page: https://gitlab.com/documatt/sphinxcontrib-constdata
Author: Documatt s.r.o.
Author-email: documatt@documatt.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Utilities
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: AUTHORS

.. |project| replace:: sphinxcontrib-constdata

.. image:: docs/img/logo.svg
   :align: right

#########
|project|
#########

.. image:: https://gitlab.com/documatt/sphinxcontrib-constdata/badges/master/pipeline.svg
    :target: https://gitlab.com/documatt/sphinxcontrib-constdata/

.. the rest of file included in docs/index.rst

|project| is the extension for `Sphinx documentation <https://www.sphinx-doc.org/>`_ 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
*****

|project| 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 <https://techwriter.documatt.com>`_ blog.

*********
Impressum
*********

|project| is open source licensed under BSD3.

Project logo and icon "table-multiple" provided by `materialdesignicons.com <https://materialdesignicons.com/icon/table-multiple>`_.



