Skip to content

Commit 82c2b5c

Browse files
authored
Update mkdocs (#6769)
1 parent 9a429a1 commit 82c2b5c

29 files changed

+112
-32
lines changed

docs/api-guide/authentication.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: authentication.py
1+
---
2+
source:
3+
- authentication.py
4+
---
25

36
# Authentication
47

docs/api-guide/content-negotiation.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: negotiation.py
1+
---
2+
source:
3+
- negotiation.py
4+
---
25

36
# Content negotiation
47

docs/api-guide/exceptions.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: exceptions.py
1+
---
2+
source:
3+
- exceptions.py
4+
---
25

36
# Exceptions
47

docs/api-guide/fields.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: fields.py
1+
---
2+
source:
3+
- fields.py
4+
---
25

36
# Serializer fields
47

docs/api-guide/filtering.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: filters.py
1+
---
2+
source:
3+
- filters.py
4+
---
25

36
# Filtering
47

docs/api-guide/format-suffixes.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: urlpatterns.py
1+
---
2+
source:
3+
- urlpatterns.py
4+
---
25

36
# Format suffixes
47

docs/api-guide/generic-views.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
source: mixins.py
2-
generics.py
1+
---
2+
source:
3+
- mixins.py
4+
- generics.py
5+
---
36

47
# Generic views
58

docs/api-guide/metadata.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: metadata.py
1+
---
2+
source:
3+
- metadata.py
4+
---
25

36
# Metadata
47

docs/api-guide/parsers.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: parsers.py
1+
---
2+
source:
3+
- parsers.py
4+
---
25

36
# Parsers
47

docs/api-guide/permissions.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: permissions.py
1+
---
2+
source:
3+
- permissions.py
4+
---
25

36
# Permissions
47

docs/api-guide/relations.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: relations.py
1+
---
2+
source:
3+
- relations.py
4+
---
25

36
# Serializer relations
47

docs/api-guide/renderers.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: renderers.py
1+
---
2+
source:
3+
- renderers.py
4+
---
25

36
# Renderers
47

docs/api-guide/requests.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: request.py
1+
---
2+
source:
3+
- request.py
4+
---
25

36
# Requests
47

docs/api-guide/responses.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: response.py
1+
---
2+
source:
3+
- response.py
4+
---
25

36
# Responses
47

docs/api-guide/reverse.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: reverse.py
1+
---
2+
source:
3+
- reverse.py
4+
---
25

36
# Returning URLs
47

docs/api-guide/routers.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: routers.py
1+
---
2+
source:
3+
- routers.py
4+
---
25

36
# Routers
47

docs/api-guide/schemas.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: schemas.py
1+
---
2+
source:
3+
- schemas.py
4+
---
25

36
# Schemas
47

docs/api-guide/serializers.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: serializers.py
1+
---
2+
source:
3+
- serializers.py
4+
---
25

36
# Serializers
47

docs/api-guide/settings.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: settings.py
1+
---
2+
source:
3+
- settings.py
4+
---
25

36
# Settings
47

docs/api-guide/status-codes.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: status.py
1+
---
2+
source:
3+
- status.py
4+
---
25

36
# Status Codes
47

docs/api-guide/testing.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: test.py
1+
---
2+
source:
3+
- test.py
4+
---
25

36
# Testing
47

docs/api-guide/throttling.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: throttling.py
1+
---
2+
source:
3+
- throttling.py
4+
---
25

36
# Throttling
47

docs/api-guide/validators.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: validators.py
1+
---
2+
source:
3+
- validators.py
4+
---
25

36
# Validators
47

docs/api-guide/versioning.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: versioning.py
1+
---
2+
source:
3+
- versioning.py
4+
---
25

36
# Versioning
47

docs/api-guide/views.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
source: decorators.py
2-
views.py
1+
---
2+
source:
3+
- decorators.py
4+
- views.py
5+
---
36

47
# Class-based Views
58

docs/api-guide/viewsets.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
source: viewsets.py
1+
---
2+
source:
3+
- viewsets.py
4+
---
25

36
# ViewSets
47

mkdocs.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@ site_description: Django REST framework - Web APIs for Django
44

55
repo_url: https://github.com/encode/django-rest-framework
66

7-
theme_dir: docs_theme
7+
theme:
8+
name: mkdocs
9+
custom_dir: docs_theme
810

911
markdown_extensions:
1012
- toc:
1113
anchorlink: True
1214

13-
pages:
15+
nav:
1416
- Home: 'index.md'
1517
- Tutorial:
1618
- 'Quickstart': 'tutorial/quickstart.md'
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
# MkDocs to build our documentation.
2-
mkdocs==0.16.3
2+
mkdocs==1.0.4

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ deps =
5151
-rrequirements/requirements-testing.txt
5252

5353
[testenv:docs]
54-
basepython = python2.7
54+
basepython = python3.7
5555
skip_install = true
5656
commands = mkdocs build
5757
deps =

0 commit comments

Comments
 (0)