From 82c2b5c3e75debe047eebd8a17b50c1e17594663 Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Sun, 30 Jun 2019 19:04:36 -0700 Subject: [PATCH] Update mkdocs (#6769) --- docs/api-guide/authentication.md | 5 ++++- docs/api-guide/content-negotiation.md | 5 ++++- docs/api-guide/exceptions.md | 5 ++++- docs/api-guide/fields.md | 5 ++++- docs/api-guide/filtering.md | 5 ++++- docs/api-guide/format-suffixes.md | 5 ++++- docs/api-guide/generic-views.md | 7 +++++-- docs/api-guide/metadata.md | 5 ++++- docs/api-guide/parsers.md | 5 ++++- docs/api-guide/permissions.md | 5 ++++- docs/api-guide/relations.md | 5 ++++- docs/api-guide/renderers.md | 5 ++++- docs/api-guide/requests.md | 5 ++++- docs/api-guide/responses.md | 5 ++++- docs/api-guide/reverse.md | 5 ++++- docs/api-guide/routers.md | 5 ++++- docs/api-guide/schemas.md | 5 ++++- docs/api-guide/serializers.md | 5 ++++- docs/api-guide/settings.md | 5 ++++- docs/api-guide/status-codes.md | 5 ++++- docs/api-guide/testing.md | 5 ++++- docs/api-guide/throttling.md | 5 ++++- docs/api-guide/validators.md | 5 ++++- docs/api-guide/versioning.md | 5 ++++- docs/api-guide/views.md | 7 +++++-- docs/api-guide/viewsets.md | 5 ++++- mkdocs.yml | 6 ++++-- requirements/requirements-documentation.txt | 2 +- tox.ini | 2 +- 29 files changed, 112 insertions(+), 32 deletions(-) diff --git a/docs/api-guide/authentication.md b/docs/api-guide/authentication.md index d1939d774..3879bd70a 100644 --- a/docs/api-guide/authentication.md +++ b/docs/api-guide/authentication.md @@ -1,4 +1,7 @@ -source: authentication.py +--- +source: + - authentication.py +--- # Authentication diff --git a/docs/api-guide/content-negotiation.md b/docs/api-guide/content-negotiation.md index 8112a2e80..3a4b0357f 100644 --- a/docs/api-guide/content-negotiation.md +++ b/docs/api-guide/content-negotiation.md @@ -1,4 +1,7 @@ -source: negotiation.py +--- +source: + - negotiation.py +--- # Content negotiation diff --git a/docs/api-guide/exceptions.md b/docs/api-guide/exceptions.md index 820e6d3b8..d7d73a2f2 100644 --- a/docs/api-guide/exceptions.md +++ b/docs/api-guide/exceptions.md @@ -1,4 +1,7 @@ -source: exceptions.py +--- +source: + - exceptions.py +--- # Exceptions diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index 8a1e2a341..ecda0eed5 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -1,4 +1,7 @@ -source: fields.py +--- +source: + - fields.py +--- # Serializer fields diff --git a/docs/api-guide/filtering.md b/docs/api-guide/filtering.md index d42a0f907..be6e54afd 100644 --- a/docs/api-guide/filtering.md +++ b/docs/api-guide/filtering.md @@ -1,4 +1,7 @@ -source: filters.py +--- +source: + - filters.py +--- # Filtering diff --git a/docs/api-guide/format-suffixes.md b/docs/api-guide/format-suffixes.md index 629f003f3..39c812c3a 100644 --- a/docs/api-guide/format-suffixes.md +++ b/docs/api-guide/format-suffixes.md @@ -1,4 +1,7 @@ -source: urlpatterns.py +--- +source: + - urlpatterns.py +--- # Format suffixes diff --git a/docs/api-guide/generic-views.md b/docs/api-guide/generic-views.md index a0ed7bdea..064ef9435 100644 --- a/docs/api-guide/generic-views.md +++ b/docs/api-guide/generic-views.md @@ -1,5 +1,8 @@ -source: mixins.py - generics.py +--- +source: + - mixins.py + - generics.py +--- # Generic views diff --git a/docs/api-guide/metadata.md b/docs/api-guide/metadata.md index a3ba9ac20..fdb778626 100644 --- a/docs/api-guide/metadata.md +++ b/docs/api-guide/metadata.md @@ -1,4 +1,7 @@ -source: metadata.py +--- +source: + - metadata.py +--- # Metadata diff --git a/docs/api-guide/parsers.md b/docs/api-guide/parsers.md index be48ae7e5..f5674a191 100644 --- a/docs/api-guide/parsers.md +++ b/docs/api-guide/parsers.md @@ -1,4 +1,7 @@ -source: parsers.py +--- +source: + - parsers.py +--- # Parsers diff --git a/docs/api-guide/permissions.md b/docs/api-guide/permissions.md index fd4a101b4..2c84e1a28 100644 --- a/docs/api-guide/permissions.md +++ b/docs/api-guide/permissions.md @@ -1,4 +1,7 @@ -source: permissions.py +--- +source: + - permissions.py +--- # Permissions diff --git a/docs/api-guide/relations.md b/docs/api-guide/relations.md index 2048cd923..aa7f23aff 100644 --- a/docs/api-guide/relations.md +++ b/docs/api-guide/relations.md @@ -1,4 +1,7 @@ -source: relations.py +--- +source: + - relations.py +--- # Serializer relations diff --git a/docs/api-guide/renderers.md b/docs/api-guide/renderers.md index fc35261f1..4e54874f0 100644 --- a/docs/api-guide/renderers.md +++ b/docs/api-guide/renderers.md @@ -1,4 +1,7 @@ -source: renderers.py +--- +source: + - renderers.py +--- # Renderers diff --git a/docs/api-guide/requests.md b/docs/api-guide/requests.md index 28450f082..967303dd1 100644 --- a/docs/api-guide/requests.md +++ b/docs/api-guide/requests.md @@ -1,4 +1,7 @@ -source: request.py +--- +source: + - request.py +--- # Requests diff --git a/docs/api-guide/responses.md b/docs/api-guide/responses.md index e9c2d41f1..1a56b0101 100644 --- a/docs/api-guide/responses.md +++ b/docs/api-guide/responses.md @@ -1,4 +1,7 @@ -source: response.py +--- +source: + - response.py +--- # Responses diff --git a/docs/api-guide/reverse.md b/docs/api-guide/reverse.md index 00abcf571..70df42b8f 100644 --- a/docs/api-guide/reverse.md +++ b/docs/api-guide/reverse.md @@ -1,4 +1,7 @@ -source: reverse.py +--- +source: + - reverse.py +--- # Returning URLs diff --git a/docs/api-guide/routers.md b/docs/api-guide/routers.md index 09c6c39cb..5f6802222 100644 --- a/docs/api-guide/routers.md +++ b/docs/api-guide/routers.md @@ -1,4 +1,7 @@ -source: routers.py +--- +source: + - routers.py +--- # Routers diff --git a/docs/api-guide/schemas.md b/docs/api-guide/schemas.md index b09b1606e..94332c0ed 100644 --- a/docs/api-guide/schemas.md +++ b/docs/api-guide/schemas.md @@ -1,4 +1,7 @@ -source: schemas.py +--- +source: + - schemas.py +--- # Schemas diff --git a/docs/api-guide/serializers.md b/docs/api-guide/serializers.md index feb5651f7..0bc90b40a 100644 --- a/docs/api-guide/serializers.md +++ b/docs/api-guide/serializers.md @@ -1,4 +1,7 @@ -source: serializers.py +--- +source: + - serializers.py +--- # Serializers diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md index 1b3cb9dcf..1da79a477 100644 --- a/docs/api-guide/settings.md +++ b/docs/api-guide/settings.md @@ -1,4 +1,7 @@ -source: settings.py +--- +source: + - settings.py +--- # Settings diff --git a/docs/api-guide/status-codes.md b/docs/api-guide/status-codes.md index c39afe397..a37ba15d4 100644 --- a/docs/api-guide/status-codes.md +++ b/docs/api-guide/status-codes.md @@ -1,4 +1,7 @@ -source: status.py +--- +source: + - status.py +--- # Status Codes diff --git a/docs/api-guide/testing.md b/docs/api-guide/testing.md index 5ca01b4e7..369e2c07b 100644 --- a/docs/api-guide/testing.md +++ b/docs/api-guide/testing.md @@ -1,4 +1,7 @@ -source: test.py +--- +source: + - test.py +--- # Testing diff --git a/docs/api-guide/throttling.md b/docs/api-guide/throttling.md index c2b06756a..713cc47cc 100644 --- a/docs/api-guide/throttling.md +++ b/docs/api-guide/throttling.md @@ -1,4 +1,7 @@ -source: throttling.py +--- +source: + - throttling.py +--- # Throttling diff --git a/docs/api-guide/validators.md b/docs/api-guide/validators.md index 9b2fc82ed..3c3b3d15c 100644 --- a/docs/api-guide/validators.md +++ b/docs/api-guide/validators.md @@ -1,4 +1,7 @@ -source: validators.py +--- +source: + - validators.py +--- # Validators diff --git a/docs/api-guide/versioning.md b/docs/api-guide/versioning.md index c106e536d..ad76ced3d 100644 --- a/docs/api-guide/versioning.md +++ b/docs/api-guide/versioning.md @@ -1,4 +1,7 @@ -source: versioning.py +--- +source: + - versioning.py +--- # Versioning diff --git a/docs/api-guide/views.md b/docs/api-guide/views.md index 7b2c4eff7..29e7997aa 100644 --- a/docs/api-guide/views.md +++ b/docs/api-guide/views.md @@ -1,5 +1,8 @@ -source: decorators.py - views.py +--- +source: + - decorators.py + - views.py +--- # Class-based Views diff --git a/docs/api-guide/viewsets.md b/docs/api-guide/viewsets.md index e7cf4d48f..cd765d3e6 100644 --- a/docs/api-guide/viewsets.md +++ b/docs/api-guide/viewsets.md @@ -1,4 +1,7 @@ -source: viewsets.py +--- +source: + - viewsets.py +--- # ViewSets diff --git a/mkdocs.yml b/mkdocs.yml index 83b3c8141..b855b69b2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,13 +4,15 @@ site_description: Django REST framework - Web APIs for Django repo_url: https://github.com/encode/django-rest-framework -theme_dir: docs_theme +theme: + name: mkdocs + custom_dir: docs_theme markdown_extensions: - toc: anchorlink: True -pages: +nav: - Home: 'index.md' - Tutorial: - 'Quickstart': 'tutorial/quickstart.md' diff --git a/requirements/requirements-documentation.txt b/requirements/requirements-documentation.txt index 012ec99f1..73158043e 100644 --- a/requirements/requirements-documentation.txt +++ b/requirements/requirements-documentation.txt @@ -1,2 +1,2 @@ # MkDocs to build our documentation. -mkdocs==0.16.3 +mkdocs==1.0.4 diff --git a/tox.ini b/tox.ini index ab5e54cc3..699ca909c 100644 --- a/tox.ini +++ b/tox.ini @@ -51,7 +51,7 @@ deps = -rrequirements/requirements-testing.txt [testenv:docs] -basepython = python2.7 +basepython = python3.7 skip_install = true commands = mkdocs build deps =