sphinxcontrib.datatemplates — Render Your Data Readable¶

sphinxcontrib.datatemplates helps you use static data in machine readable format in your documentation by letting you define Jinja2 templates to turn JSON, YAML, XML, or CSV data into reStructuredText for Sphinx to render as part of its output.

  • Repo: https://github.com/sphinxcontrib/sphinxcontrib.datatemplates

  • Docs: http://sphinxcontribdatatemplates.readthedocs.io/

  • Installing sphinxcontrib.datatemplates
  • Using datatemplate
    • Directives
    • Template Files
    • Template Context
    • Template Helpers
  • No Data Sample
    • Loading the Template
    • Rendered Output
  • JSON Samples
    • Data File
    • Template File
    • Loading the Template
    • Rendered Output
  • YAML Samples
    • Single Document
    • Multiple Documents in One Source
  • XML Samples
    • Data File
    • Template File
    • Loading the Template
    • Rendered Output
  • Import-Module Samples
    • Template File
    • Loading the Template
    • Rendered Output
  • CSV Samples
    • Data File
    • Template File
    • Loading the Template
    • Rendered Output
  • DBM Samples
    • Creating Data File
    • Template File
    • Loading the Template
    • Rendered Output
  • Inline Sample
    • Data File
    • HTML Context
    • An Inline Template
    • Rendered Output
  • Multiple Data Sources
    • Data Files
    • Using load() in a Template
    • Loading the Template
    • Rendered Output
  • Legacy Samples
    • Data File
    • Template File
    • Rendered Output
  • CLI Samples
    • Help
    • Data File
    • Template File
    • Rendering a Template
    • Experimenting by Dumping Data
  • Release History
    • 0.10.0
    • 0.9.1
    • 0.9.0
    • 0.8.0
    • 0.7.2
    • 0.7.0
    • 0.6.1
    • 0.6.0
    • 0.5.0
    • 0.4.0
    • 0.3.0
    • 0.2.0
    • 0.1.0

Indices and tables¶

  • Index

  • Module Index

  • Search Page

sphinxcontrib.datatemplates

Navigation

  • Installing sphinxcontrib.datatemplates
  • Using datatemplate
  • No Data Sample
  • JSON Samples
  • YAML Samples
  • XML Samples
  • Import-Module Samples
  • CSV Samples
  • DBM Samples
  • Inline Sample
  • Multiple Data Sources
  • Legacy Samples
  • CLI Samples
  • Release History

Related Topics

  • Documentation overview
    • Next: Installing sphinxcontrib.datatemplates

Quick search

©2015, Doug Hellmann. | Powered by Sphinx 8.2.3 & Alabaster 0.7.16 | Page source