# django-docutils

> Docutils (reStructuredText) support for Django templates, views, and template engines.

## Documentation

- [Quickstart](https://django-docutils.git-pull.com/quickstart/): For latest official version:
- [Topics](https://django-docutils.git-pull.com/topics/): High-level guides covering django-docutils features, configuration, and common patterns.
- [API Reference](https://django-docutils.git-pull.com/api/): Exception definitions for django-docutils.
- [Project](https://django-docutils.git-pull.com/project/): Information for contributors and maintainers.
- [Changelog](https://django-docutils.git-pull.com/history/): To install the unreleased django-docutils version, see developmental releases.

## Documentation

- [exc](https://django-docutils.git-pull.com/api/exc/): Exceptions for Django Docutils.
- [lib.directives.code](https://django-docutils.git-pull.com/api/lib/directives/code/): Pygments docutils directive.
- [lib.directives](https://django-docutils.git-pull.com/api/lib/directives/): Douctils directives for django-docutils.
- [lib.directives.registry](https://django-docutils.git-pull.com/api/lib/directives/registry/): Register douctils directives for django-docutils.
- [lib](https://django-docutils.git-pull.com/api/lib/)
- [lib.metadata.extract](https://django-docutils.git-pull.com/api/lib/metadata/extract/): Title, Subtitle, and Metadata extraction of reStructuredText.
- [lib.metadata](https://django-docutils.git-pull.com/api/lib/metadata/): Metadata extraction and processing for Django Docutils.
- [lib.metadata.process](https://django-docutils.git-pull.com/api/lib/metadata/process/): Metadata is a catch-all term for information for an RST document.
- [lib.metadata.processors](https://django-docutils.git-pull.com/api/lib/metadata/processors/): Metadata processing for Django Docutils.
- [lib.publisher](https://django-docutils.git-pull.com/api/lib/publisher/): Docutils Publisher fors for Django Docutils.
- [lib.roles.common](https://django-docutils.git-pull.com/api/lib/roles/common/): Core parts for Django Docutils roles.
- [lib.roles.email](https://django-docutils.git-pull.com/api/lib/roles/email/): Email role for docutils.
- [lib.roles.file](https://django-docutils.git-pull.com/api/lib/roles/file/): File role for Docutils.
- [lib.roles.github](https://django-docutils.git-pull.com/api/lib/roles/github/): GitHub role for Docutils.
- [lib.roles.hackernews](https://django-docutils.git-pull.com/api/lib/roles/hackernews/): HN (HackerNews) role for Docutils.
- [lib.roles](https://django-docutils.git-pull.com/api/lib/roles/): Docutils roles for django-docutils.
- [lib.roles.kbd](https://django-docutils.git-pull.com/api/lib/roles/kbd/): <kbd> (Keyboard Input Element) role for Docutils.
- [lib.roles.leanpub](https://django-docutils.git-pull.com/api/lib/roles/leanpub/): Leanpub role for Docutils.
- [lib.roles.pypi](https://django-docutils.git-pull.com/api/lib/roles/pypi/): PyPI (Python Package Index) role for docutils.
- [lib.roles.readthedocs](https://django-docutils.git-pull.com/api/lib/roles/readthedocs/): ReadTheDocs role for Docutils.
- [lib.roles.registry](https://django-docutils.git-pull.com/api/lib/roles/registry/): Register docutils roles for django-docutils.
- [lib.roles.twitter](https://django-docutils.git-pull.com/api/lib/roles/twitter/): Twitter role for docutils.
- [lib.roles.types](https://django-docutils.git-pull.com/api/lib/roles/types/): Typings for Django Docutils roles for Docutils.
- [lib.roles.url](https://django-docutils.git-pull.com/api/lib/roles/url/): URL Role for docutils.
- [lib.roles.wikipedia](https://django-docutils.git-pull.com/api/lib/roles/wikipedia/): Wikipedia role for Docutils.
- [lib.settings](https://django-docutils.git-pull.com/api/lib/settings/): Settings objects and type-mapping for Django Docutils library package.
- [lib.text](https://django-docutils.git-pull.com/api/lib/text/): Text related utilities for Django Docutils.
- [lib.roles.transforms.code](https://django-docutils.git-pull.com/api/lib/transforms/code/): Code related formatter and transformers.
- [lib.transforms](https://django-docutils.git-pull.com/api/lib/transforms/): Docutils transformers for Django Docutils.
- [lib.roles.transforms.toc](https://django-docutils.git-pull.com/api/lib/transforms/toc/): Django docutils table of contents helpers.
- [lib.utils](https://django-docutils.git-pull.com/api/lib/utils/): Docutils util functions and regexes.
- [lib.views](https://django-docutils.git-pull.com/api/lib/views/): Django view machinery for rendering docutils content as HTML.
- [lib.writers](https://django-docutils.git-pull.com/api/lib/writers/): Docutils writers for Django Docutils, designed for cleaner output.
- [template](https://django-docutils.git-pull.com/api/template/): Django template engine for Docutils.
- [templatetags.django_docutils](https://django-docutils.git-pull.com/api/templatetags/django_docutils/): Django template tag and filter for docutils (rendering reStructuredText as HTML).
- [templatetags](https://django-docutils.git-pull.com/api/templatetags/): Package for Django templatetags for docutils.
- [views](https://django-docutils.git-pull.com/api/views/): Django-docutils class-based view for django (and its’ parts).
- [Code Style](https://django-docutils.git-pull.com/project/code-style/): django-docutils uses ruff for both linting and formatting.
- [Development](https://django-docutils.git-pull.com/project/contributing/): Install git and uv.
- [Releasing](https://django-docutils.git-pull.com/project/releasing/): django-docutils is pre-1.0. Minor version bumps may include breaking changes. Users should pin to >=0.x,<0.y.
- [Class-based view](https://django-docutils.git-pull.com/topics/class_based_view/): You can also use a class-based view to render reStructuredText (reST).
- [FAQ](https://django-docutils.git-pull.com/topics/faq/): reStructuredText is a markup syntax, similar to markdown.
- [Template filter](https://django-docutils.git-pull.com/topics/template_filter/): Make sure django_docutils is added your INSTALLED_APPS in your settings file:
- [Template tag](https://django-docutils.git-pull.com/topics/template_tag/): Make sure django_docutils is added your INSTALLED_APPS in your settings file: