Skip to main content

Sphinx directives for CSV-powered tabular authoring.

Project description

sphinx-tabular

Full documentation

Features

  • Sphinx extension.
  • Uses standard CSV file format.
  • Easily merge table cells with < and ^.
  • Support reStructuredText and Markdown.
  • Support for inline table data and external files.
  • Optional sticky header support for one or more header rows.
  • Provides a minimal set of spreadsheet formulas.
  • Set table cell alignment and per-cell alignment in both horizontal and vertical directions.
  • Set custom cell text and background colors.
  • Custom status pill.
  • Support for Font Awesome and Bootstrip icons if installed by your theme.

Installation

pip install sphinx-tabular

conf.py

extensions = [
    ...,
    'sphinx_tabular',
    ...,
]

Directives

RST, external file:

.. rcsv-table:: Title
    :file: table.rcsv

RST, inline data.

.. rcsv-table:: Title

    Col 1, Row 1
    Col 2, Row 2

MD, external file:

.. rcsv-table:: Title
    :file: table.rcsv

MD, inline data.

.. rcsv-table:: Title

    Col 1, Row 1
    Col 2, Row 2

Merging Cells

Columns

.. rcsv-table:: Title

    Merged,<
    Unmerged, Unmerged

Rows

.. rcsv-table:: Title

    Merged,Unmerged
    ^, Unmerged

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_tabular-0.1.2.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_tabular-0.1.2-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_tabular-0.1.2.tar.gz.

File metadata

  • Download URL: sphinx_tabular-0.1.2.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sphinx_tabular-0.1.2.tar.gz
Algorithm Hash digest
SHA256 08e2834a7edc95d1c901c5902efcbe0748ca1049bfcb6f719859bf6589a23ad3
MD5 ae7826dfe76d1bc836c8d54a6bf3c5d9
BLAKE2b-256 4e868073b8b1a9ccfc89fcb0f491f0be030f9712fbb85e31ba3900a154205fe6

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_tabular-0.1.2.tar.gz:

Publisher: publish.yml on deepthinker2001/sphinx-tabular

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinx_tabular-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: sphinx_tabular-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 20.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sphinx_tabular-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0f864ce53ed89c221ceb87352d6ae2edc23f18a5f977dd8b6668e5c215881e54
MD5 304b95646ac3cfc336d8631334825c66
BLAKE2b-256 3c6761ee19c3f7580a5edb316d81c6b54d607af4445a609b158c86f07d88b6c9

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_tabular-0.1.2-py3-none-any.whl:

Publisher: publish.yml on deepthinker2001/sphinx-tabular

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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