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.1a14.tar.gz (10.1 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.1a14-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for sphinx_autodoc_docutils-0.0.1a14.tar.gz
Algorithm Hash digest
SHA256 4ccfc2a11ab7899bc55e00232ea00d65361ef420215dfdbb2b3168910ff2cf0d
MD5 b490a5d6a21804b5bdcb14adcd53f106
BLAKE2b-256 90d3ad958e058badb016ca6a92c5273b155cc4fc017127a7d1e28c5e06898254

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_autodoc_docutils-0.0.1a14.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.1a14-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_autodoc_docutils-0.0.1a14-py3-none-any.whl
Algorithm Hash digest
SHA256 d951ca98ab7eccf9ba8e70706239d6cbcd3f932207fc80e175bb448ac7bbb0ab
MD5 c8e3ab03296a30bc43c7caf80654033c
BLAKE2b-256 d47603ce49bcc63a602d81c8d65a13d248c280b69bee39e92764404c0052fc8b

See more details on using hashes here.

Provenance

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