From e6c7468055a3f79695e8dadf3bf613128c2a6f8a Mon Sep 17 00:00:00 2001 From: Dougal Matthews Date: Sun, 31 May 2015 18:26:10 +0100 Subject: [PATCH] Use the new pages structure. This is optional, but will be required by MkDocs 1.0 --- mkdocs.yml | 97 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 50 insertions(+), 47 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 8aacc2dfc..efb43f394 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,50 +7,53 @@ repo_url: https://github.com/tomchristie/django-rest-framework theme_dir: docs_theme pages: - - ['index.md', 'Home'] - - ['tutorial/quickstart.md', 'Tutorial', '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', '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', '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/versioning.md', 'API Guide', 'Versioning'] - - ['api-guide/content-negotiation.md', 'API Guide', 'Content negotiation'] - - ['api-guide/metadata.md', 'API Guide', 'Metadata'] - - ['api-guide/format-suffixes.md', 'API Guide', 'Format suffixes'] - - ['api-guide/reverse.md', 'API Guide', 'Returning URLs'] - - ['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/internationalization.md', 'Topics', 'Internationalization'] - - ['topics/ajax-csrf-cors.md', 'Topics', 'AJAX, CSRF & CORS'] - - ['topics/browser-enhancements.md', 'Topics',] - - ['topics/browsable-api.md', 'Topics', 'The Browsable API'] - - ['topics/rest-hypermedia-hateoas.md', 'Topics', 'REST, Hypermedia & HATEOAS'] - - ['topics/third-party-resources.md', 'Topics', 'Third Party Resources'] - - ['topics/contributing.md', 'Topics', 'Contributing to REST framework'] - - ['topics/project-management.md', 'Topics', 'Project management'] - - ['topics/3.0-announcement.md', 'Topics', '3.0 Announcement'] - - ['topics/3.1-announcement.md', 'Topics', '3.1 Announcement'] - - ['topics/kickstarter-announcement.md', 'Topics', 'Kickstarter Announcement'] - - ['topics/release-notes.md', 'Topics', 'Release Notes'] + - Home: 'index.md' + - Tutorial: + - 'Quickstart': 'tutorial/quickstart.md' + - '1 - Serialization': 'tutorial/1-serialization.md' + - '2 - Requests and responses': 'tutorial/2-requests-and-responses.md' + - '3 - Class based views': 'tutorial/3-class-based-views.md' + - '4 - Authentication and permissions': 'tutorial/4-authentication-and-permissions.md' + - '5 - Relationships and hyperlinked APIs': 'tutorial/5-relationships-and-hyperlinked-apis.md' + - '6 - Viewsets and routers': 'tutorial/6-viewsets-and-routers.md' + - API Guide: + - 'Requests': 'api-guide/requests.md' + - 'Responses': 'api-guide/responses.md' + - 'Views': 'api-guide/views.md' + - 'Generic views': 'api-guide/generic-views.md' + - 'Viewsets': 'api-guide/viewsets.md' + - 'Routers': 'api-guide/routers.md' + - 'Parsers': 'api-guide/parsers.md' + - 'Renderers': 'api-guide/renderers.md' + - 'Serializers': 'api-guide/serializers.md' + - 'Serializer fields': 'api-guide/fields.md' + - 'Serializer relations': 'api-guide/relations.md' + - 'Validators': 'api-guide/validators.md' + - 'Authentication': 'api-guide/authentication.md' + - 'Permissions': 'api-guide/permissions.md' + - 'Throttling': 'api-guide/throttling.md' + - 'Filtering': 'api-guide/filtering.md' + - 'Pagination': 'api-guide/pagination.md' + - 'Versioning': 'api-guide/versioning.md' + - 'Content negotiation': 'api-guide/content-negotiation.md' + - 'Metadata': 'api-guide/metadata.md' + - 'Format suffixes': 'api-guide/format-suffixes.md' + - 'Returning URLs': 'api-guide/reverse.md' + - 'Exceptions': 'api-guide/exceptions.md' + - 'Status codes': 'api-guide/status-codes.md' + - 'Testing': 'api-guide/testing.md' + - 'Settings': 'api-guide/settings.md' + - Topics: + - 'Documenting your API': 'topics/documenting-your-api.md' + - 'Internationalization': 'topics/internationalization.md' + - 'AJAX, CSRF & CORS': 'topics/ajax-csrf-cors.md' + - 'Browser Enhancements': 'topics/browser-enhancements.md' + - 'The Browsable API': 'topics/browsable-api.md' + - 'REST, Hypermedia & HATEOAS': 'topics/rest-hypermedia-hateoas.md' + - 'Third Party Resources': 'topics/third-party-resources.md' + - 'Contributing to REST framework': 'topics/contributing.md' + - 'Project management': 'topics/project-management.md' + - '3.0 Announcement': 'topics/3.0-announcement.md' + - '3.1 Announcement': 'topics/3.1-announcement.md' + - 'Kickstarter Announcement': 'topics/kickstarter-announcement.md' + - 'Release Notes': 'topics/release-notes.md'