This extension makes it easy to use more expressive tables in Sphinx documentation with DataTables. See the demo and full documentation online.
pip install sphinx-datatablesAdd the extension in your conf.py:
extensions = [
"sphinxcontrib.jquery",
"sphinx_datatables",
]In your .rst documentation, create a table and add a custom class label.
Your table must have a valid header row.
.. csv-table::
:header: First Name,Last Name
:class: sphinx-datatable
John,Smith
Jane,DoeThe following configuration options are available with the following default values:
# in conf.py
# set the version to use for DataTables plugin
datatables_version = "1.13.4"
# name of the class to use for tables to enable DataTables
datatables_class = "sphinx-datatable"
# any custom options to pass to the DataTables constructor. Note that any
# options you set are used for all DataTables.
datatables_options = {}