lib.views

Django view machinery for rendering docutils content as HTML.

class django_docutils.lib.views.TitleMixin
class[source]

Bases: ContextMixin

ContextMixin that capitalizes title and subtitle.

title = None
attribute
subtitle = None
attribute
get_context_data(**kwargs)
method[source]

django_docutils.lib.text.smart_title() on title and subtitle.

Parameters:

kwargs (object)

Return type:

dict[str, Any]

class django_docutils.lib.views.TemplateTitleView
class[source]

Bases: TemplateView, TitleMixin

Combination of Template and Title mixin.

title = None
attribute
subtitle = None
attribute
get_context_data(**kwargs)
method[source]

Return context data.

Parameters:

kwargs (object)

Return type:

dict[str, Any]

class django_docutils.lib.views.RSTMixin
class[source]

Bases: object

Django Class-based view mixin for reStructuredText.

request: HttpRequest
attribute
raw_content
attribute

Raw reStructuredText content.

doctree
attribute

Return docutils doctree of RST content (pre-HTML).

sidebar
attribute

Return table of contents sidebar of RST content as HTML.

content
attribute

Return reStructuredText content as HTML.

get_base_template()
method[source]

TODO: move this out of RSTMixin, it is AMP related, not RST.

Return type:

str

class django_docutils.lib.views.RSTRawView
class[source]

Bases: TemplateTitleView

Send pure reStructuredText to template.

Requires template tags to process it.

{% load django_docutils %}
{% block content %}
  <div id="content_wrapper" class="content docutils-html fixed-toc-content">
    {% restructuredtext content show_title=False %}
  </div>
{% endblock content %}

{% block sidebar %}
  {% restructuredtext content toc_only=True %}
{% endblock sidebar %}
template_name = 'rst/raw.html'
attribute
file_path: StrPath | None = None
attribute
title = None
attribute
get_context_data(**kwargs)
method[source]

Merge content to context data.

Parameters:

kwargs (object)

Return type:

dict[str, Any]

class django_docutils.lib.views.RSTView
class[source]

Bases: RSTRawView, RSTMixin

RestructuredText Django View.

template_name = 'rst/base.html'
attribute
file_path: StrPath | None = None
attribute
title = None
attribute
raw_content
attribute

Raw reStructuredText data.

get_context_data(**kwargs)
method[source]

Merge content and sidebar to context data.

Parameters:

kwargs (object)

Return type:

dict[str, Any]