| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122 |
- """
- Sphinx documentation generator configuration.
- More information on the configuration options is available at:
- http://www.sphinx-doc.org/en/master/usage/configuration.html
- """
- from os import environ
- import django
- import sphinx_rtd_theme
- from pkg_resources import get_distribution
- environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.settings")
- django.setup()
- # -- Extra custom configuration ------------------------------------------
- title = "django-axes documentation"
- description = ("Keep track of failed login attempts in Django-powered sites.",)
- # -- General configuration ------------------------------------------------
- # Add any Sphinx extension module names here, as strings.
- # They can be extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
- extensions = ["sphinx.ext.autodoc"]
- # Add any paths that contain templates here, relative to this directory.
- templates_path = ["_templates"]
- # The suffix(es) of source filenames.
- # You can specify multiple suffix as a list of string: source_suffix = ['.rst', '.md']
- source_suffix = ".rst"
- # The master toctree document.
- master_doc = "index"
- # General information about the project.
- project = "django-axes"
- copyright = "2016, Jazzband"
- author = "Jazzband"
- # The full version, including alpha/beta/rc tags.
- release = get_distribution("django-axes").version
- # The short X.Y version.
- version = ".".join(release.split(".")[:2])
- # The language for content autogenerated by Sphinx. Refer to documentation
- # for a list of supported languages.
- #
- # This is also used if you do content translation via gettext catalogs.
- # Usually you set "language" from the command line for these cases.
- language = None
- # List of patterns, relative to source directory, that match files and
- # directories to ignore when looking for source files.
- exclude_patterns = ["_build"]
- # The name of the Pygments (syntax highlighting) style to use.
- pygments_style = "sphinx"
- # If true, `todo` and `todoList` produce output, else they produce nothing.
- todo_include_todos = False
- # -- Options for HTML output ----------------------------------------------
- # The theme to use for HTML and HTML Help pages. See the documentation for
- # a list of builtin themes.
- html_theme = "sphinx_rtd_theme"
- # Add any paths that contain custom themes here, relative to this directory.
- html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
- # Add any paths that contain custom static files (such as style sheets) here,
- # relative to this directory. They are copied after the builtin static files,
- # so a file named "default.css" will overwrite the builtin "default.css".
- html_static_path = ["_static"]
- # Custom sidebar templates, maps document names to template names.
- html_sidebars = {
- "**": ["globaltoc.html", "relations.html", "sourcelink.html", "searchbox.html"]
- }
- # Output file base name for HTML help builder.
- htmlhelp_basename = "DjangoAxesdoc"
- # -- Options for LaTeX output ---------------------------------------------
- latex_elements = {
- "papersize": "a4paper",
- "pointsize": "12pt",
- "preamble": "",
- "figure_align": "htbp",
- }
- # Grouping the document tree into LaTeX files. List of tuples
- # (source start file, target name, title, author, documentclass [howto, manual, or own class]).
- latex_documents = [(master_doc, "DjangoAxes.tex", title, author, "manual")]
- # -- Options for manual page output ---------------------------------------
- # One entry per manual page. List of tuples
- # (source start file, name, description, authors, manual section).
- man_pages = [(master_doc, "djangoaxes", description, [author], 1)]
- # -- Options for Texinfo output -------------------------------------------
- # Grouping the document tree into Texinfo files. List of tuples
- # (source start file, target name, title, author, dir menu entry, description, category)
- texinfo_documents = [
- (
- master_doc,
- "DjangoAxes",
- title,
- author,
- "DjangoAxes",
- description,
- "Miscellaneous",
- )
- ]
|