core

core.admin

Django admin interface for core models.

core.forms

class core.forms.FacetField(choices=(), required=True, widget=None, label=None, initial=None, help_text=u'', *args, **kwargs)

For filtering searches on a facet, with validation for the format of facet values.

valid_value(value)

Although this is a choice field, no choices need to be supplied. Instead, we just validate that the value is in the correct format for facet filtering (facet_name:value)

class core.forms.FacetedSearchForm(*args, **kwargs)

Supports fetching faceted results with a corresponding query.

facets

A list of facet names for which to get facet counts

models

Limit the search to one or more models

core.middleware

class core.middleware.SingleVersionMiddleware

Reset urlconf for requests for ‘single_version’ docs.

In settings.MIDDLEWARE_CLASSES, SingleVersionMiddleware must follow after SubdomainMiddleware.

core.models

class core.models.UserProfile(*args, **kwargs)

Additional information about a User.

get_contribution_details()

Gets the line to put into commits to attribute the author.

Returns a tuple (name, email)

core.search_sites

core.views

Core views, including the main homepage, post-commit build hook, documentation and header rendering, and server errors.

core.views.default_docs_kwargs(request, project_slug=None)

Return kwargs used to reverse lookup a project’s default docs URL.

Determining which URL to redirect to is done based on the kwargs passed to reverse(serve_docs, kwargs). This function populates kwargs for the default docs for a project, and sets appropriate keys depending on whether request is for a subdomain URL, or a non-subdomain URL.

core.views.get_suggestion(project_slug, lang_slug, version_slug, pagename, user)

# | project | version | language | What to show |

1 | 0 | 0 | 0 | Error message |

2 | 0 | 0 | 1 | Error message (Can’t happen) |

3 | 0 | 1 | 0 | Error message (Can’t happen) |

4 | 0 | 1 | 1 | Error message (Can’t happen) |

5 | 1 | 0 | 0 | A link to top-level page of default version |

6 | 1 | 0 | 1 | Available versions on the translation project |

7 | 1 | 1 | 0 | Available translations of requested version |

8 | 1 | 1 | 1 | A link to top-level page of requested version |

core.views.github_build(*args, **kwargs)

A post-commit hook for github.

core.views.redirect_lang_slug(request, lang_slug, project_slug=None)

Redirect /en/ to /en/latest/.

core.views.redirect_page_with_filename(request, filename, project_slug=None)

Redirect /page/file.html to /en/latest/file.html.

core.views.redirect_project_slug(request, project_slug=None)

Redirect / to /en/latest/.

core.views.redirect_version_slug(request, version_slug, project_slug=None)

Redirect /latest/ to /en/latest/.

core.views.server_error(request, template_name='500.html')

A simple 500 handler so we get media

core.views.server_error_404(request, template_name='404.html')

A simple 404 handler so we get media

core.management.commands

This is where custom manage.py commands are defined.

class core.management.commands.update_repos.Command

Custom management command to rebuild documentation for all projects on the site. Invoked via ./manage.py update_repos.