Metadata-Version: 2.4
Name: sphinx-autodoc-docutils
Version: 0.0.1a18
Summary: Sphinx extension for documenting docutils directives and roles as first-class reference entries
Project-URL: Repository, https://github.com/git-pull/gp-sphinx
Author-email: Tony Narlock <tony@git-pull.com>
License: MIT
Keywords: autodoc,directives,documentation,docutils,roles,sphinx
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Typing :: Typed
Requires-Python: <4.0,>=3.10
Requires-Dist: sphinx-autodoc-typehints-gp==0.0.1a18
Requires-Dist: sphinx-ux-autodoc-layout==0.0.1a18
Requires-Dist: sphinx-ux-badges==0.0.1a18
Requires-Dist: sphinx>=8.1
Description-Content-Type: text/markdown

# 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

```console
$ pip install sphinx-autodoc-docutils
```

## Usage

```python
extensions = ["sphinx_autodoc_docutils"]
```

Then document directive classes and role callables with `eval-rst`:

````md
```{eval-rst}
.. autodirective:: my_project.docs_ext.MyDirective
```

```{eval-rst}
.. autorole:: my_project.docs_roles.cli_option_role
```
````

For module-wide reference pages:

```rst
.. autodirectives:: my_project.docs_ext

.. autoroles:: my_project.docs_roles
```

## Documentation

See the [full documentation](https://gp-sphinx.git-pull.com/packages/sphinx-autodoc-docutils/)
for live demos, directive option rendering, and downstream usage patterns.
