# sphinx-list-items
[](https://spdx.org/licenses/GPL-3.0-only.html)
[](https://pypi.python.org/pypi/sphinx-list-items)
[](https://pypi.python.org/pypi/sphinx-list-items)
A Sphinx extension to automatically list figures, tables, and Sphinx version directives (`versionadded`, `versionchanged`, `deprecated`, `versionremoved`) in your documentation. Output as a bulleted list or a customizable table, with filtering and advanced options.
## Features
- List all figures or tables in your documentation
- List Sphinx version directives (with prefix-stripping for cleaner output)
- Output as a bulleted list or a table (with custom columns)
- Filter version items by version number
- Works with cross-references and section links
## Installation
```bash
pip install sphinx-list-items
```
Or for development:
```bash
pip install -e .
```
## Setup
Add to your `conf.py`:
```python
extensions = ['sphinx_list_items']
```
## Usage
### List all figures (as a list)
```rst
.. list-items:: figures
:list:
```
### List all figures (as a table)
```rst
.. list-items:: figures
:table:
```
### List all tables (as a list)
```rst
.. list-items:: tables
:list:
```
### List all tables (as a table)
```rst
.. list-items:: tables
:table:
```
### List Sphinx version directives (as a list)
```rst
.. list-items:: versionadded
:list:
.. list-items:: versionchanged
:list:
.. list-items:: deprecated
:list:
.. list-items:: versionremoved
:list:
```
### List Sphinx version directives (as a table)
```rst
.. list-items:: versionadded
:table:
```
### Filter version items by version
```rst
.. list-items:: versionadded
:table:
:version: 0.0.2
```
### Custom columns for tables
```rst
.. list-items:: versionchanged
:table: docname, version, text, type
```
## Advanced
- All output supports cross-references to the source location.
- Version directive output strips the prefix (e.g., "Added in version 1.0.0:") for clean summaries.
- You can use `:list:` or `:table:` for any supported type.
- For tables, you can specify custom columns (e.g., `:table: id, caption`).
## Example
See the [examples](doc/content/examples.rst) and [specimens](doc/content/specimens.rst) in this repository for real-world usage.
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-list-items",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Sphinx, Extension, list, sphinx-list, list-items",
"author": null,
"author_email": "JoKneeMo <jokneemo@example.com>",
"download_url": "https://files.pythonhosted.org/packages/ee/b5/621786b942580a18cff5788d0e53b05fa213247f6e0867da2f8b1c62d499/sphinx_list_items-1.0.0.tar.gz",
"platform": null,
"description": "\n# sphinx-list-items\n[](https://spdx.org/licenses/GPL-3.0-only.html)\n[](https://pypi.python.org/pypi/sphinx-list-items)\n[](https://pypi.python.org/pypi/sphinx-list-items)\n\nA Sphinx extension to automatically list figures, tables, and Sphinx version directives (`versionadded`, `versionchanged`, `deprecated`, `versionremoved`) in your documentation. Output as a bulleted list or a customizable table, with filtering and advanced options.\n\n## Features\n\n- List all figures or tables in your documentation\n- List Sphinx version directives (with prefix-stripping for cleaner output)\n- Output as a bulleted list or a table (with custom columns)\n- Filter version items by version number\n- Works with cross-references and section links\n\n## Installation\n\n```bash\npip install sphinx-list-items\n```\n\nOr for development:\n\n```bash\npip install -e .\n```\n\n## Setup\n\nAdd to your `conf.py`:\n\n```python\nextensions = ['sphinx_list_items']\n```\n\n## Usage\n\n### List all figures (as a list)\n\n```rst\n.. list-items:: figures\n :list:\n```\n\n### List all figures (as a table)\n\n```rst\n.. list-items:: figures\n :table:\n```\n\n### List all tables (as a list)\n\n```rst\n.. list-items:: tables\n :list:\n```\n\n### List all tables (as a table)\n\n```rst\n.. list-items:: tables\n :table:\n```\n\n### List Sphinx version directives (as a list)\n\n```rst\n.. list-items:: versionadded\n :list:\n\n.. list-items:: versionchanged\n :list:\n\n.. list-items:: deprecated\n :list:\n\n.. list-items:: versionremoved\n :list:\n```\n\n### List Sphinx version directives (as a table)\n\n```rst\n.. list-items:: versionadded\n :table:\n```\n\n### Filter version items by version\n\n```rst\n.. list-items:: versionadded\n :table:\n :version: 0.0.2\n```\n\n### Custom columns for tables\n\n```rst\n.. list-items:: versionchanged\n :table: docname, version, text, type\n```\n\n## Advanced\n\n- All output supports cross-references to the source location.\n- Version directive output strips the prefix (e.g., \"Added in version 1.0.0:\") for clean summaries.\n- You can use `:list:` or `:table:` for any supported type.\n- For tables, you can specify custom columns (e.g., `:table: id, caption`).\n\n## Example\n\nSee the [examples](doc/content/examples.rst) and [specimens](doc/content/specimens.rst) in this repository for real-world usage.\n",
"bugtrack_url": null,
"license": null,
"summary": "A Sphinx extension to list items such as figures, tables, versionadded, etc.",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://sphinx-list-items.jokneemo.com",
"Homepage": "https://sphinx-list-items.jokneemo.com",
"Issues": "https://github.com/JoKneeMo/sphinx-list-items/issues",
"Repository": "https://github.com/JoKneeMo/sphinx-list-items"
},
"split_keywords": [
"sphinx",
" extension",
" list",
" sphinx-list",
" list-items"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "266842a806ad2aead66054e5ca27eabe24a41af20320af2f639aa0461a4660e7",
"md5": "25d99c8aa1d957dd06ceacbd5bf46815",
"sha256": "e3fbf24dc784652c1179de5a4ba5107911e1ab9e35efc64a7e8dc02a75827d84"
},
"downloads": -1,
"filename": "sphinx_list_items-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "25d99c8aa1d957dd06ceacbd5bf46815",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 20539,
"upload_time": "2025-09-05T06:26:32",
"upload_time_iso_8601": "2025-09-05T06:26:32.904934Z",
"url": "https://files.pythonhosted.org/packages/26/68/42a806ad2aead66054e5ca27eabe24a41af20320af2f639aa0461a4660e7/sphinx_list_items-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "eeb5621786b942580a18cff5788d0e53b05fa213247f6e0867da2f8b1c62d499",
"md5": "c6a74aebf8fbbf874d6af00406a8f927",
"sha256": "aed39f01a55f443c918119f07d171c80f62894b32dc6782a762e1548ca2d4f04"
},
"downloads": -1,
"filename": "sphinx_list_items-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "c6a74aebf8fbbf874d6af00406a8f927",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19372,
"upload_time": "2025-09-05T06:26:34",
"upload_time_iso_8601": "2025-09-05T06:26:34.570406Z",
"url": "https://files.pythonhosted.org/packages/ee/b5/621786b942580a18cff5788d0e53b05fa213247f6e0867da2f8b1c62d499/sphinx_list_items-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-05 06:26:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JoKneeMo",
"github_project": "sphinx-list-items",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "sphinx",
"specs": [
[
">=",
"5.0.2"
]
]
}
],
"lcname": "sphinx-list-items"
}
JSON
