django.contrib.admindocs.utils

Constant	`ROLES`	Undocumented
Variable	`docutils_is_available`	Undocumented
Variable	`named_group_matcher`	Undocumented
Variable	`unnamed_group_matcher`	Undocumented
Function	`create_reference_role`	Undocumented
Function	`default_reference_role`	Undocumented
Function	`get_view_name`	Undocumented
Function	`parse_docstring`	Parse out the parts of a docstring. Return (title, body, metadata).
Function	`parse_rst`	Convert the string from reST to an XHTML fragment.
Function	`replace_named_groups`	No summary
Function	`replace_unnamed_groups`	No summary

ROLES: dict[str, str] =

Undocumented

Value

{'model': '%s/models/%s/',
 'view': '%s/views/%s/',
 'template': '%s/templates/%s/',
 'filter': '%s/filters/#%s',
 'tag': '%s/tags/#%s'}

docutils_is_available: bool =

Undocumented

named_group_matcher =

Undocumented

unnamed_group_matcher =

Undocumented

def create_reference_role(rolename, urlbase):

Undocumented

def default_reference_role(name, rawtext, text, lineno, inliner, options=None, content=None):

Undocumented

def get_view_name(view_func):

Undocumented

def parse_docstring(docstring):

Parse out the parts of a docstring. Return (title, body, metadata).

def parse_rst(text, default_reference_context, thing_being_parsed=None):

Convert the string from reST to an XHTML fragment.

def replace_named_groups(pattern):

Find named groups in pattern and replace them with the group name. E.g., 1. ^(?P<a>w+)/b/(w+)$ ==> ^<a>/b/(w+)$ 2. ^(?P<a>w+)/b/(?P<c>w+)/$ ==> ^<a>/b/<c>/$ 3. ^(?P<a>w+)/b/(w+) ==> ^<a>/b/(w+) 4. ^(?P<a>w+)/b/(?P<c>w+) ==> ^<a>/b/<c>

def replace_unnamed_groups(pattern):

Find unnamed groups in pattern and replace them with '<var>'. E.g., 1. ^(?P<a>w+)/b/(w+)$ ==> ^(?P<a>w+)/b/<var>$ 2. ^(?P<a>w+)/b/((x|y)w+)$ ==> ^(?P<a>w+)/b/<var>$ 3. ^(?P<a>w+)/b/(w+) ==> ^(?P<a>w+)/b/<var> 4. ^(?P<a>w+)/b/((x|y)w+) ==> ^(?P<a>w+)/b/<var>