mirror of
https://github.com/jazzband/django-axes.git
synced 2026-03-16 22:30:23 +00:00
125 lines
4 KiB
Python
125 lines
4 KiB
Python
"""
|
|
Sphinx documentation generator configuration.
|
|
|
|
More information on the configuration options is available at:
|
|
|
|
https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
"""
|
|
|
|
# import sphinx_rtd_theme
|
|
from importlib.metadata import version as get_version
|
|
|
|
import django
|
|
from django.conf import settings
|
|
|
|
settings.configure(INSTALLED_APPS=["django", "django.contrib.auth", "axes"], DEBUG=True)
|
|
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_rtd_theme","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_version("django-axes")
|
|
|
|
# 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"
|
|
|
|
html_style = "css/custom_theme.css"
|
|
|
|
# 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",
|
|
)
|
|
]
|