8. Code Listing¶

A Sphinx extension to list items (figures, tables, etc.) in your documentation.

Project Source: https://github.com/JoKneeMo/sphinx-list-items

Copyright 2025 - JoKneeMo

Licensed under GNU General Public License version 3 (GPLv3).

class sphinx_list_items.ListItemsDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)[source]¶

Sphinx directive to list items (figures, tables, versions, etc.).

Options:

list:

Output as a bulleted list (default)

table:

Output as a table (optionally specify columns)

version:

Only show entries for the specified version (for versionadded, versionchanged, etc.)

final_argument_whitespace = False¶

May the final argument contain whitespace?

has_content = False¶

May the directive have content?

optional_arguments = 0¶

Number of optional arguments after the required arguments.

required_arguments = 1¶

Number of required directive arguments.

class sphinx_list_items.ListItemsNode(rawsource='', *children, **attributes)[source]¶

sphinx-list-items: Sphinx extension to list figures in documents

sphinx_list_items.figures.create_figure_list_output(app, env, node, fromdocname)[source]¶

Create bulleted list output for figures

sphinx_list_items.figures.create_figure_table_output(app, env, node, fromdocname, columns)[source]¶

Create table output for figures with specified columns

sphinx-list-items: Sphinx extension to list tables in documents