lib.types

Typed settings dictionaries for django-docutils configuration. See lib.settings for the live settings objects that use these types.

Typings for Django Docutils settings for django.

class django_docutils.lib.types.DjangoDocutilsLibRSTRolesSettings
class[source]
class[source]
class django_docutils.lib.types.DjangoDocutilsLibRSTRolesSettings

Bases: TypedDict

Docutils role mappings.

local: dict[str, str]
attribute
attribute
local: dict[str, str]
class django_docutils.lib.types.DjangoDocutilsLibRSTDocutilsSettings
class[source]
class[source]
class django_docutils.lib.types.DjangoDocutilsLibRSTDocutilsSettings

Bases: TypedDict

Docutils document settings.

file_insertion_enabled: bool
attribute
attribute
file_insertion_enabled: bool
raw_enabled: bool
attribute
attribute
raw_enabled: bool
_disable_config: bool
attribute
attribute
_disable_config: bool
line_length_limit: int
attribute
attribute
line_length_limit: int
strip_comments: bool
attribute
attribute
strip_comments: bool
initial_header_level: int
attribute
attribute
initial_header_level: int
class django_docutils.lib.types.DjangoDocutilsLibRSTSettings
class[source]
class[source]
class django_docutils.lib.types.DjangoDocutilsLibRSTSettings

Bases: TypedDict

Core settings object for DJANGO_DOCUTILS_LIB_RST.

allow_unsafe_docutils_settings: bool
attribute
attribute
allow_unsafe_docutils_settings: bool
allowed_uri_schemes: Sequence[str]
attribute
attribute
allowed_uri_schemes: Sequence[str]
metadata_processors: list[str]
attribute
attribute
metadata_processors: list[str]
transforms: list[str]
attribute
attribute
transforms: list[str]
docutils: DjangoDocutilsLibRSTDocutilsSettings
attribute
attribute
docutils: DjangoDocutilsLibRSTDocutilsSettings
directives: dict[str, str]
attribute
attribute
directives: dict[str, str]
roles: DjangoDocutilsLibRSTRolesSettings
attribute
attribute
roles: DjangoDocutilsLibRSTRolesSettings
class django_docutils.lib.types.DjangoDocutilsLibTextSettings
class[source]
class[source]
class django_docutils.lib.types.DjangoDocutilsLibTextSettings

Bases: TypedDict

Core settings object for DJANGO_DOCUTILS_LIB_TEXT.

uncapitalized_word_filters: list[str]
attribute
attribute
uncapitalized_word_filters: list[str]