liran-funaro / sphinx-markdown-builder / 40645820589

100%

push

github

Add an option to generate compact Markdown tables (#81)

**Description**

This change adds the `markdown_compact_tables` configuration option to
generate Markdown tables without padding cells to align columns in the
source.

The option defaults to `False`, preserving the existing table output.
When enabled, tables use compact rows and Markdown header separators
while retaining cell content, inline formatting, and the existing
conversion of line breaks to `<br/>`.

**Rationale**

Column padding can substantially increase the size of generated Markdown
when tables contain long values. Compact output reduces unnecessary
whitespace for consumers such as coding agents.

This also allows Apache Airflow to replace its custom compact-table
workaround with an upstream configuration option as part of
[#74376](https://github.com/apache/airflow/issues/74376).

**Documentation**

Added `markdown_compact_tables` to the documented `conf.py`
configuration options, explaining that it removes column-alignment
padding when enabled and defaults to `False` to preserve existing
formatting.

**Tests**

Added unit tests verifying that:

- Default mode retains the existing `tabulate` output.
- Compact mode generates tables without column padding.
- Numeric strings, inline formatting, and multiline cell content are
preserved.
- Empty tables produce no output.

**Backwards Compatibility**

The new option is disabled by default, so existing builds retain their
current formatting. Compact mode uses ordinary Markdown separators and
does not reproduce `tabulate`’s automatic numeric alignment.

Closes: #80

---------

Signed-off-by: Sameer Mesiah <smesiah971@gmail.com>

9 of 16 new or added lines in 3 files covered. (56.25%)

782 of 803 relevant lines covered (97.38%)

2.92 hits per line