Add API reference into docs

This commit is contained in:
Aleksi Häkli 2019-04-27 16:34:12 +03:00
parent 3dc69a4f56
commit 41307e6c55
3 changed files with 39 additions and 2 deletions

30
docs/10_reference.rst Normal file
View file

@ -0,0 +1,30 @@
.. _reference:
10. API reference
=================
Axes offers extendable APIs that you can customize to your liking.
You can specialize the following base classes or altenatively
implement your own classes based on the following base implementations.
AxesBackend
-----------
.. automodule:: axes.backends
:members:
AxesHandler
---------------
.. automodule:: axes.handlers.base
:members:
AxesMiddleware
--------------
.. automodule:: axes.middleware
:members:

View file

@ -6,9 +6,15 @@ More information on the configuration options is available at:
http://www.sphinx-doc.org/en/master/usage/configuration.html
"""
import sphinx_rtd_theme
import os
import axes
import django
import sphinx_rtd_theme
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'axes.tests.settings')
django.setup()
# -- Extra custom configuration ------------------------------------------
@ -19,7 +25,7 @@ description = 'Keep track of failed login attempts in Django-powered sites.',
# Add any Sphinx extension module names here, as strings.
# They can be extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = []
extensions = ['sphinx.ext.autodoc']
# Add any paths that contain templates here, relative to this directory.
templates_path = [

View file

@ -18,6 +18,7 @@ Contents
7_upgrading
8_development
9_architecture
10_reference
Indices and tables
------------------