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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for sphinx_autodoc_docutils-0.0.1a19.tar.gz
Algorithm Hash digest
SHA256 c3078a37906c947d41700eb18a6b824bc5033a3515db7907559d60ebf58f5fe6
MD5 b0f05aeba639d0d1e6988c689ac69657
BLAKE2b-256 bd783eefc077c70ac398bd9a90c323ac6f31c35508acbba5942a86459c7a3ece

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_autodoc_docutils-0.0.1a19-py3-none-any.whl
Algorithm Hash digest
SHA256 b47e6a581604a569cf0dedaa52d12ea45ad369980433fd46d9d7139efea966df
MD5 4faac1d9924f8fc37ce859a97e9606b1
BLAKE2b-256 6aa12d3c914415fcdf6a6ce79344d1739a82d9a161e890c078970a60f4cccf9d

See more details on using hashes here.

Provenance

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