Skip to main content

Searchable and sortable tables in Sphinx documentation

Project description

This extension makes it easy to use more expressive tables in Sphinx documentation with DataTables. See the demo and full documentation online.

Installation

pip install sphinx-datatables

Usage

Add 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,Doe

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

sphinx-datatables-0.1.1.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

sphinx_datatables-0.1.1-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-datatables-0.1.1.tar.gz.

File metadata

  • Download URL: sphinx-datatables-0.1.1.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.16

File hashes

Hashes for sphinx-datatables-0.1.1.tar.gz
Algorithm Hash digest
SHA256 bb6c000a5ea2d533a128193aa58ef8ff91b07fc946f9595ee08ff19ef4e55cea
MD5 fde4f409cb063d30d35f9366e54407af
BLAKE2b-256 7b491f1cae84a937354f04281a0fc8762c5ea27654c40b7109edf340d9ddd224

See more details on using hashes here.

File details

Details for the file sphinx_datatables-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_datatables-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 133d77f1268a5d6052ba1b05ff072577eb5c7cbf86c2395881cb8b48f725d080
MD5 0ac56e476bae58408df7a57feda68163
BLAKE2b-256 72dd0c2d9b5a9dfbdd4104faf3c399b1a34d6d4876ab5ebc8dec80cc1812d547

See more details on using hashes here.

Supported by

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