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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for sphinx_autodoc_docutils-0.0.1a13.tar.gz
Algorithm Hash digest
SHA256 55a71c7625186b02d2a356d28e8bff771f42303d6e176bc9ebf674302054a109
MD5 38b1f4ae58de9472fc760406684c86d0
BLAKE2b-256 efed4bd998f4bc951fa16e7884282b86828fd27b2f0eecf0e6d6c95196e20763

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_autodoc_docutils-0.0.1a13-py3-none-any.whl
Algorithm Hash digest
SHA256 92ac237123176128be2ed5246900d60c6714c36794a28113bd78c5e7ab2dc1b4
MD5 099c6a6bb3225c5791a636ee33674d71
BLAKE2b-256 c6d3609c9e8931620d7ef0f1be93abcbfe82faa97e87a952a14d6e235831ef0d

See more details on using hashes here.

Provenance

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