From b733f85ff1e3f70e9f5dee6f52bebe861bc0f411 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 25 Nov 2014 16:24:35 +0000 Subject: [PATCH] Minor docs tweaks --- docs/index.md | 2 +- mkdocs.yml | 49 ++++++++++++++++++++++++------------------------- 2 files changed, 25 insertions(+), 26 deletions(-) diff --git a/docs/index.md b/docs/index.md index ca10befe3..9312bb2fd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -172,7 +172,7 @@ The API guide is your complete reference manual to all the functionality provide * [Serializers][serializers] * [Serializer fields][fields] * [Serializer relations][relations] -* [Validators][validators] + * [Authentication][authentication] * [Permissions][permissions] * [Throttling][throttling] diff --git a/mkdocs.yml b/mkdocs.yml index f956ecf0b..e112315be 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,38 +7,38 @@ repo_url: https://github.com/tomchristie/django-rest-framework theme_dir: docs_theme pages: - - ['index.md', ] - - ['tutorial/quickstart.md', ] + - ['index.md', 'Home'] + - ['tutorial/quickstart.md', 'Quickstart'] - ['tutorial/1-serialization.md', 'Tutorial', '1 - Serialization'] - ['tutorial/2-requests-and-responses.md', 'Tutorial', '2 - Requests and responses'] - ['tutorial/3-class-based-views.md', 'Tutorial', '3 - Class based views'] - ['tutorial/4-authentication-and-permissions.md', 'Tutorial', '4 - Authentication and permissions'] - ['tutorial/5-relationships-and-hyperlinked-apis.md', 'Tutorial', '5 - Relationships and hyperlinked APIs'] - - ['tutorial/6-viewsets-and-routers.md', 'Tutorial', '6- Viewsets and routers'] - - ['api-guide/requests.md', 'API Guide', ] - - ['api-guide/responses.md', 'API Guide', ] - - ['api-guide/views.md', 'API Guide', ] - - ['api-guide/generic-views.md', 'API Guide', ] - - ['api-guide/viewsets.md', 'API Guide', ] - - ['api-guide/routers.md', 'API Guide', ] - - ['api-guide/parsers.md', 'API Guide', ] - - ['api-guide/renderers.md', 'API Guide', ] - - ['api-guide/serializers.md', 'API Guide', ] + - ['tutorial/6-viewsets-and-routers.md', 'Tutorial', '6 - Viewsets and routers'] + - ['api-guide/requests.md', 'API Guide', 'Requests'] + - ['api-guide/responses.md', 'API Guide', 'Responses'] + - ['api-guide/views.md', 'API Guide', 'Views'] + - ['api-guide/generic-views.md', 'API Guide', 'Generic views'] + - ['api-guide/viewsets.md', 'API Guide', 'Viewsets'] + - ['api-guide/routers.md', 'API Guide', 'Routers'] + - ['api-guide/parsers.md', 'API Guide', 'Parsers'] + - ['api-guide/renderers.md', 'API Guide', 'Renderers'] + - ['api-guide/serializers.md', 'API Guide', 'Serializers'] - ['api-guide/fields.md', 'API Guide', 'Serializer fields'] - ['api-guide/relations.md', 'API Guide', 'Serializer relations'] - - ['api-guide/validators.md', 'API Guide', ] - - ['api-guide/authentication.md', 'API Guide', ] - - ['api-guide/permissions.md', 'API Guide', ] - - ['api-guide/throttling.md', 'API Guide', ] - - ['api-guide/filtering.md', 'API Guide', ] - - ['api-guide/pagination.md', 'API Guide', ] - - ['api-guide/content-negotiation.md', 'API Guide', ] - - ['api-guide/format-suffixes.md', 'API Guide', ] +# - ['api-guide/validators.md', 'API Guide', 'Validators'] + - ['api-guide/authentication.md', 'API Guide', 'Authentication'] + - ['api-guide/permissions.md', 'API Guide', 'Permissions'] + - ['api-guide/throttling.md', 'API Guide', 'Throttling'] + - ['api-guide/filtering.md', 'API Guide', 'Filtering'] + - ['api-guide/pagination.md', 'API Guide', 'Pagination'] + - ['api-guide/content-negotiation.md', 'API Guide', 'Content negotiation'] + - ['api-guide/format-suffixes.md', 'API Guide', 'Format suffixes'] - ['api-guide/reverse.md', 'API Guide', 'Returning URLs'] - - ['api-guide/exceptions.md', 'API Guide', ] - - ['api-guide/status-codes.md', 'API Guide', ] - - ['api-guide/testing.md', 'API Guide', ] - - ['api-guide/settings.md', 'API Guide', ] + - ['api-guide/exceptions.md', 'API Guide', 'Exceptions'] + - ['api-guide/status-codes.md', 'API Guide', 'Status codes'] + - ['api-guide/testing.md', 'API Guide', 'Testing'] + - ['api-guide/settings.md', 'API Guide', 'Settings'] - ['topics/documenting-your-api.md', 'Topics', 'Documenting your API'] - ['topics/ajax-csrf-cors.md', 'Topics', 'AJAX, CSRF & CORS'] - ['topics/browser-enhancements.md', 'Topics',] @@ -54,5 +54,4 @@ pages: - ['topics/release-notes.md', 'Topics', 'Release Notes'] - ['topics/credits.md', 'Topics', 'Credits'] -copyright: Copyright © 2014, Tom Christie. google_analytics: ['UA-18852272-2', 'django-rest-framework.org']