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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for sphinx_autodoc_docutils-0.0.1a27.tar.gz
Algorithm Hash digest
SHA256 8f814fe540d762e801c1cfd8913b71c421e86e5f3cd0d08a02e19b2981308f06
MD5 931da6a16f52068713504665b9e5b184
BLAKE2b-256 f28d8a680c10a9372241b1ab8d2f0c8183c69a09b50b44fc97310acdcc0c6ff0

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_autodoc_docutils-0.0.1a27-py3-none-any.whl
Algorithm Hash digest
SHA256 03d80cbec353764e7aa3ffc031eb8945661a7424429d2a74c9428a94698f8de2
MD5 2d72efde7a1e718d23007db29f9c777e
BLAKE2b-256 119407ee910632fab59f145a191ed273797fcedeb9dd70bdfa60176dde31528b

See more details on using hashes here.

Provenance

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