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.1.tar.gz (28.3 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib.datatemplates-0.9.1-py2.py3-none-any.whl (13.9 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: sphinxcontrib.datatemplates-0.9.1.tar.gz
  • Upload date:
  • Size: 28.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.7.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for sphinxcontrib.datatemplates-0.9.1.tar.gz
Algorithm Hash digest
SHA256 942b606cd13aaf76b166fe4e0aa50a26820eda03ddf2d2c6c205f037efb08713
MD5 2b20887de69589ae4700fbd15ed01d32
BLAKE2b-256 1d1919c81d69497e95d9f25fd5f0e54467171e62d966d167ecd76a281b0db1c7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for sphinxcontrib.datatemplates-0.9.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 844a325316bd2318002cac53ce40a66e674b0842329b14d19b2d7162f9d04aec
MD5 fc6b5fd596302accb3396348c72395c9
BLAKE2b-256 d0ac592b46966f373c82b3fe52d5c333c1fb206671adb7742b3c0b0ffc92d8ab

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