sphinx-autodoc-docutils

Sphinx extension for turning docutils components — directives, roles, transforms, readers, parsers, writers, custom nodes, and translators — into copyable reference entries inside your docs site.

The extension keeps its semantic rst:* parse path, but the rendered body regions, badges, and shared type formatting now come from sphinx_ux_autodoc_layout, sphinx_ux_badges, and sphinx_autodoc_typehints_gp.

Install

$ pip install sphinx-autodoc-docutils

Usage

extensions = ["sphinx_autodoc_docutils"]

Then document directive classes and role callables with eval-rst:

```{eval-rst}
.. autodirective:: my_project.docs_ext.MyDirective
```

```{eval-rst}
.. autorole:: my_project.docs_roles.cli_option_role
```

Every docutils extension point gets the same single + bulk pair:

.. autotransform:: my_project.transforms.SanitizeTransform

.. autoreader:: my_project.readers.ArticleReader

.. autoparser:: my_project.parsers.LineParser

.. autowriter:: my_project.writers.PlainWriter

.. autonode:: my_project.nodes.icon

.. autotranslator:: my_project.writers.PlainTranslator

For module-wide reference pages:

.. autodirectives:: my_project.docs_ext

.. autoroles:: my_project.docs_roles

.. autotransforms:: my_project

Component entries register targets in a docutils Sphinx domain, so prose can cross-reference them with roles like :docutils:transform:`SanitizeTransform`.

Documentation

See the full documentation for live demos, directive option rendering, and downstream usage patterns.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_autodoc_docutils-0.1.0a37.tar.gz (22.8 kB view details)

Uploaded Jul 27, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

sphinx_autodoc_docutils-0.1.0a37-py3-none-any.whl (32.7 kB view details)

Uploaded Jul 27, 2026 Python 3

File details

Details for the file sphinx_autodoc_docutils-0.1.0a37.tar.gz.

File metadata

Download URL: sphinx_autodoc_docutils-0.1.0a37.tar.gz
Upload date: Jul 27, 2026
Size: 22.8 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for sphinx_autodoc_docutils-0.1.0a37.tar.gz
Algorithm	Hash digest
SHA256	`37b00e217656b878cc9744977a533a91e984ed62deca4fd8385b4606021570b9`
MD5	`ecdad98b87540be57b40a0d492a62ab4`
BLAKE2b-256	`ff557d5da93c29f688e7c2959caf1d320327c8ecca951c8a9b6fee819e4b8ac6`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_docutils-0.1.0a37.tar.gz:

Publisher: release.yml on git-pull/gp-sphinx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: sphinx_autodoc_docutils-0.1.0a37.tar.gz
- Subject digest: 37b00e217656b878cc9744977a533a91e984ed62deca4fd8385b4606021570b9
- Sigstore transparency entry: 2256729556
- Sigstore integration time: Jul 27, 2026
Source repository:
- Permalink: git-pull/gp-sphinx@aeb3c6a436c52698f1b9bee97cf48cefb23035b3
- Branch / Tag: refs/tags/v0.1.0a37
- Owner: https://github.com/git-pull
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@aeb3c6a436c52698f1b9bee97cf48cefb23035b3
- Trigger Event: push