Skip to content

[Feature Request]: Render lists like tables #2734

@theletterf

Description

@theletterf

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

Tables and definition lists don't seem ideal when trying to render lists of settings. We would need something that mixes the convenience of tabular design with an approach that allow us to define lists à la MyST list-table directives or through YAML.

See: https://myst-parser.readthedocs.io/en/latest/syntax/tables.html#list-tables

Proposed Solution

A directive that allows us to render a table from a list, like this:

:::{list-table} Frozen Delights!
:widths: 15 10 30
:header-rows: 1

*   - Treat
    - Quantity
    - Description
*   - Albatross
    - 2.99
    - On a stick!
*   - Crunchy Frog
    - 1.49
    - If we took the bones out, it wouldn't be
 crunchy, now would it?
*   - Gannet Ripple
    - 1.99
    - On a stick!
:::

Examples and Research

No response

Alternative Solutions

No response

Additional Context

How important is this feature to you?

Important

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions