Skip to main content

Sphinx extension for documenting docutils directives and roles as first-class reference entries

Project description

sphinx-autodoc-docutils

Sphinx extension for turning docutils directives and roles 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
```

For module-wide reference pages:

.. autodirectives:: my_project.docs_ext

.. autoroles:: my_project.docs_roles

Documentation

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

Project details


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.0.1a22.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

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

sphinx_autodoc_docutils-0.0.1a22-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_autodoc_docutils-0.0.1a22.tar.gz.

File metadata

File hashes

Hashes for sphinx_autodoc_docutils-0.0.1a22.tar.gz
Algorithm Hash digest
SHA256 c2e792a67dcd580b556b2eee22cfc34d047ef8070c4189351dd97c7be01449bf
MD5 eaa74d35b8e6bb1ae54289a1aa3986f5
BLAKE2b-256 b79c0569e27bd7f21ad0dec9ee4042f98033df9cb4e560f432d3640b4f385282

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_docutils-0.0.1a22.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.

File details

Details for the file sphinx_autodoc_docutils-0.0.1a22-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_autodoc_docutils-0.0.1a22-py3-none-any.whl
Algorithm Hash digest
SHA256 e28fa48fdf869a3789176c9dffd77fd9b7a301d3c18ec41e446ddc4d827f9d7b
MD5 fbff2c312a1806a6cdb9825b594cbda8
BLAKE2b-256 72f5a09bb286ccedbe8a483888e32f76a3e0e4318e56f2a0b89d8536288ff13a

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_docutils-0.0.1a22-py3-none-any.whl:

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.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page