Metadata-Version: 2.4
Name: sphinx-tabular
Version: 0.1.2
Summary: Sphinx directives for CSV-powered tabular authoring.
Author: Your Name
License-Expression: MIT
Project-URL: Homepage, https://github.com/deepthinker2001/sphinx-tabular
Project-URL: Documentation, https://deepthinker2001.github.io/sphinx-tabular/
Project-URL: Repository, https://github.com/deepthinker2001/sphinx-tabular
Project-URL: Issues, https://github.com/deepthinker2001/sphinx-tabular/issues
Keywords: sphinx,documentation,csv,tables,restructuredtext,myst
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.12
Description-Content-Type: text/markdown
Requires-Dist: sphinx>=9.1
Requires-Dist: docutils>=0.20
Requires-Dist: myst-parser>=5
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=9.1; python_version >= "3.12" and extra == "docs"
Requires-Dist: sphinx-book-theme; extra == "docs"
Requires-Dist: sphinx-design>=0.7.0; extra == "docs"

# sphinx-tabular

[Full documentation](https://deepthinker2001.github.io/sphinx-tabular/index.html)

## 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

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

## Directives

RST, external file:

```RST
.. rcsv-table:: Title
    :file: table.rcsv
```

RST, inline data.

```RST
.. rcsv-table:: Title

    Col 1, Row 1
    Col 2, Row 2
```

MD, external file:

```RST
.. rcsv-table:: Title
    :file: table.rcsv
```

MD, inline data.

```RST
.. rcsv-table:: Title

    Col 1, Row 1
    Col 2, Row 2
```


## Merging Cells

Columns

```RST
.. rcsv-table:: Title

    Merged,<
    Unmerged, Unmerged
```

Rows

```RST
.. rcsv-table:: Title

    Merged,Unmerged
    ^, Unmerged
```




