Skip to main content

Sphinx extension for rendering data files as nice HTML

Project description

This package contains sphinxcontrb.datatemplates, an extension for Sphinx to render parts of reStructuredText pages from data files in formats like JSON, YAML, and CSV.

Sample YAML Input

---
key1: value1
key2:
  - list item 1
  - list item 2
  - list item 3
nested-list:
  - ['a', 'b', 'c']
  - ['A', 'B', 'C']
mapping-series:
  - cola: a
    colb: b
    colc: c
  - cola: A
    colb: B
    colc: C

Sample Template

.. -*- mode: rst -*-

Individual Item
~~~~~~~~~~~~~~~

{{ data['key1'] }}

List of Items
~~~~~~~~~~~~~

{% for item in data['key2'] %}
- {{item}}
{% endfor %}

Nested List Table
~~~~~~~~~~~~~~~~~

Rendering a table from a list of nested sequences using hard-coded
headers.

{{ make_list_table(
    ['One', 'Two', 'Three'],
    data['nested-list'],
    title='Table from nested lists',
    ) }}

Mapping Series Table
~~~~~~~~~~~~~~~~~~~~

Rendering a table from a list of nested dictionaries using dynamic
headers.

{{ make_list_table_from_mappings(
    [('One', 'cola'), ('Two', 'colb'), ('Three', 'colc')],
    data['mapping-series'],
    title='Table from series of mappings',
    ) }}

Rendered Output

See the sphinx output online.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib.datatemplates-0.9.0.tar.gz (27.9 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib.datatemplates-0.9.0-py2.py3-none-any.whl (13.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file sphinxcontrib.datatemplates-0.9.0.tar.gz.

File metadata

  • Download URL: sphinxcontrib.datatemplates-0.9.0.tar.gz
  • Upload date:
  • Size: 27.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for sphinxcontrib.datatemplates-0.9.0.tar.gz
Algorithm Hash digest
SHA256 5003d7b8b0dc1f77ef9c368ee3e95c365fefc16d31ae8da2e1d8822733dafd30
MD5 0e753de86a83a1d4581a98549453abd6
BLAKE2b-256 1f0a449a453ac93eaa6144b660d7315132151e955e2f49b2084a866c3b602c0f

See more details on using hashes here.

File details

Details for the file sphinxcontrib.datatemplates-0.9.0-py2.py3-none-any.whl.

File metadata

  • Download URL: sphinxcontrib.datatemplates-0.9.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 13.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for sphinxcontrib.datatemplates-0.9.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 794d38f0ced9d0a79bde8041121a5da3823dd6e705ae7ed7f01bf6024a69a318
MD5 c79585b779d24855977978e978bbe60f
BLAKE2b-256 5e5fa9663a39c79ab922d55dc0d11e913ec7588db70fbe1f61625aaffc76be25

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page