From 3a757a037cc66c71bb5aa11017f4c84bfd975b90 Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Mon, 7 Nov 2016 20:33:19 -0500 Subject: [PATCH] Separate docs into separate sections --- docs/{img => assets}/form.png | Bin docs/{ => dev}/tests.txt | 0 docs/{ => guide}/install.txt | 0 docs/{ => guide}/migration.txt | 0 docs/{ => guide}/rest_framework.txt | 2 +- docs/{ => guide}/usage.txt | 0 docs/index.txt | 21 +++++++++++++++------ 7 files changed, 16 insertions(+), 7 deletions(-) rename docs/{img => assets}/form.png (100%) rename docs/{ => dev}/tests.txt (100%) rename docs/{ => guide}/install.txt (100%) rename docs/{ => guide}/migration.txt (100%) rename docs/{ => guide}/rest_framework.txt (99%) rename docs/{ => guide}/usage.txt (100%) diff --git a/docs/img/form.png b/docs/assets/form.png similarity index 100% rename from docs/img/form.png rename to docs/assets/form.png diff --git a/docs/tests.txt b/docs/dev/tests.txt similarity index 100% rename from docs/tests.txt rename to docs/dev/tests.txt diff --git a/docs/install.txt b/docs/guide/install.txt similarity index 100% rename from docs/install.txt rename to docs/guide/install.txt diff --git a/docs/migration.txt b/docs/guide/migration.txt similarity index 100% rename from docs/migration.txt rename to docs/guide/migration.txt diff --git a/docs/rest_framework.txt b/docs/guide/rest_framework.txt similarity index 99% rename from docs/rest_framework.txt rename to docs/guide/rest_framework.txt index 3e2b893..b3f2f4d 100644 --- a/docs/rest_framework.txt +++ b/docs/guide/rest_framework.txt @@ -168,4 +168,4 @@ If you are using DRF's browsable API or admin API you may also want to install ` With crispy forms installed and added to Django's ``INSTALLED_APPS``, the browsable API will present a filtering control for ``DjangoFilterBackend``, like so: -.. image:: img/form.png +.. image:: ../assets/form.png diff --git a/docs/usage.txt b/docs/guide/usage.txt similarity index 100% rename from docs/usage.txt rename to docs/guide/usage.txt diff --git a/docs/index.txt b/docs/index.txt index 5d0c5c7..9d8f897 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -7,18 +7,27 @@ the more mundane bits of view code. Specifically, it allows users to filter down a queryset based on a model's fields, displaying the form to let them do this. -Contents: +.. toctree:: + :maxdepth: 2 + :caption: User Guide + + guide/install + guide/usage + guide/rest_framework + guide/migration .. toctree:: :maxdepth: 1 + :caption: Reference Documentation - install - usage - rest_framework ref/filterset ref/filters ref/fields ref/widgets ref/settings - migration - tests + +.. toctree:: + :maxdepth: 1 + :caption: Developer Documentation + + dev/tests