From e50bbd4701d72de18c6f30eb4e0a546631a02341 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aleksi=20Ha=CC=88kli?= Date: Mon, 25 Feb 2019 22:35:44 +0200 Subject: [PATCH] Enumerate documentation source files MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Aleksi Häkli --- docs/{requirements.rst => 1_requirements.rst} | 0 docs/{installation.rst => 2_installation.rst} | 0 docs/{usage.rst => 3_usage.rst} | 4 ++- ...{configuration.rst => 4_configuration.rst} | 0 ...{customization.rst => 5_customization.rst} | 0 docs/{integration.rst => 6_integration.rst} | 2 +- docs/{migration.rst => 7_migration.rst} | 0 docs/{development.rst => 8_development.rst} | 0 docs/{architecture.rst => 9_architecture.rst} | 0 docs/index.rst | 26 ++++++++----------- 10 files changed, 15 insertions(+), 17 deletions(-) rename docs/{requirements.rst => 1_requirements.rst} (100%) rename docs/{installation.rst => 2_installation.rst} (100%) rename docs/{usage.rst => 3_usage.rst} (97%) rename docs/{configuration.rst => 4_configuration.rst} (100%) rename docs/{customization.rst => 5_customization.rst} (100%) rename docs/{integration.rst => 6_integration.rst} (99%) rename docs/{migration.rst => 7_migration.rst} (100%) rename docs/{development.rst => 8_development.rst} (100%) rename docs/{architecture.rst => 9_architecture.rst} (100%) diff --git a/docs/requirements.rst b/docs/1_requirements.rst similarity index 100% rename from docs/requirements.rst rename to docs/1_requirements.rst diff --git a/docs/installation.rst b/docs/2_installation.rst similarity index 100% rename from docs/installation.rst rename to docs/2_installation.rst diff --git a/docs/usage.rst b/docs/3_usage.rst similarity index 97% rename from docs/usage.rst rename to docs/3_usage.rst index 27b63f9..a31e972 100644 --- a/docs/usage.rst +++ b/docs/3_usage.rst @@ -1,3 +1,5 @@ +.. _usage: + Usage ===== @@ -24,4 +26,4 @@ In your code, you can use the ``axes.attempts.reset`` function. - ``reset()`` will reset all lockouts and access records. - ``reset(ip=ip)`` will clear lockouts and records for the given IP address. -- ``reset(username=username)`` will clear lockouts and records for the given username. \ No newline at end of file +- ``reset(username=username)`` will clear lockouts and records for the given username. diff --git a/docs/configuration.rst b/docs/4_configuration.rst similarity index 100% rename from docs/configuration.rst rename to docs/4_configuration.rst diff --git a/docs/customization.rst b/docs/5_customization.rst similarity index 100% rename from docs/customization.rst rename to docs/5_customization.rst diff --git a/docs/integration.rst b/docs/6_integration.rst similarity index 99% rename from docs/integration.rst rename to docs/6_integration.rst index 3f27ea4..2e6a3d6 100644 --- a/docs/integration.rst +++ b/docs/6_integration.rst @@ -1,4 +1,4 @@ -.. _usage: +.. _integration: Integration =========== diff --git a/docs/migration.rst b/docs/7_migration.rst similarity index 100% rename from docs/migration.rst rename to docs/7_migration.rst diff --git a/docs/development.rst b/docs/8_development.rst similarity index 100% rename from docs/development.rst rename to docs/8_development.rst diff --git a/docs/architecture.rst b/docs/9_architecture.rst similarity index 100% rename from docs/architecture.rst rename to docs/9_architecture.rst diff --git a/docs/index.rst b/docs/index.rst index 0efaa7c..b4a7c0d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,12 +1,7 @@ .. _index: -.. Django Axes documentation master file, created by - sphinx-quickstart on Sat Jul 30 16:37:41 2016. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to Django Axes's documentation! -======================================= +Django Axes Documentation +========================= Contents -------- @@ -14,14 +9,15 @@ Contents .. toctree:: :maxdepth: 2 - requirements - installation - usage - configuration - customization - migration - development - architecture + 1_requirements + 2_installation + 3_usage + 4_configuration + 5_customization + 6_integration + 7_migration + 8_development + 9_architecture Indices and tables ------------------