Separate docs into separate sections

2016-11-07 20:33:19 -05:00 · 2016-11-07 20:33:19 -05:00 · 3a757a037c
parent 4d02cdf958
commit 3a757a037c
7 changed files with 16 additions and 7 deletions
--- a/docs/assets/form.png
+++ b/docs/assets/form.png
--- a/docs/dev/tests.txt
+++ b/docs/dev/tests.txt
--- a/docs/guide/install.txt
+++ b/docs/guide/install.txt
--- a/docs/guide/migration.txt
+++ b/docs/guide/migration.txt
--- a/docs/guide/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
--- a/docs/guide/usage.txt
+++ b/docs/guide/usage.txt
--- 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