This release is a pre-release and may not be stable for production use.
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.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-autodoc-docutils 0.1.0a38
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_autodoc_docutils-0.1.0a38.tar.gz | 22.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_autodoc_docutils-0.1.0a38-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 55.5 kB
Release files / sphinx_autodoc_docutils-0.1.0a38.tar.gz
| Download URL | sphinx_autodoc_docutils-0.1.0a38.tar.gz |
|---|---|
| Size | 22.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d830b5645c630e241abceb371852df224863dbbbea6ad1c341df775eac38f001
|
|
BLAKE2b-256 checksum How to use checksums |
f381c9e405c4e5dd669a90f70a0b29186ea78dc86e13e581e8ea98bc140b7362
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 30, 2026.
Transparency logRelease files / sphinx_autodoc_docutils-0.1.0a38-py3-none-any.whl
| Download URL | sphinx_autodoc_docutils-0.1.0a38-py3-none-any.whl |
|---|---|
| Size | 32.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1cd6a281f985b7831668b3cea11d70763b5d8e9a184d52b65efe0057dfd71641
|
|
BLAKE2b-256 checksum How to use checksums |
276cd14fb36bc7e103493ea6a2d32b7fc59f9b818c8a885a7814c6b694ac7aab
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 30, 2026.
Transparency log
