Views¶

Views for django-shinxdoc.

class sphinxdoc.views.ProjectSearchView¶

Inherits SearchView and handles a search request and displays the results as a simple list.

build_form()¶

Instantiates the form that should be used to process the search query.

sphinxdoc.views.documentation(request, slug, path)¶

Displays the contents of a sphinxdoc.models.Document.

slug specifies the project, the document belongs to, path is the path to the original JSON file relative to the builddir and without the file extension. path may also be a directory, so this view checks if path/index exists, before trying to load path directly.

sphinxdoc.views.objects_inventory(request, slug, path)¶

Renders the objects.inv as plain text.

sphinxdoc.views.images(request, slug, path)¶

Shows the specified image.

sphinxdoc.views.source(request, slug, path)¶

Shows the ReST source of a document.