-
Notifications
You must be signed in to change notification settings - Fork 6
/
mkdocs.yml
96 lines (85 loc) · 2.87 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
site_name: Using the Django REST Framework and DRF-JSONAPI
site_url: https://columbia-it-django-jsonapi-training.readthedocs.io
site_description: Django REST framework JSONAPI Training
## N.B these URLs are overridden in mkdocs_macros_main.py:
#repo_url: https://gitlab.cc.columbia.edu/cuit-ent-arch/django-training
edit_uri: edit/master/docs/
#repo_url: https://github.com/columbia-it/django-jsonapi-training
#edit_uri: /columbia-it/django-jsonapi-training/edit/master/docs/
copyright: Copyright © 2018-2024 The Trustees of Columbia University in the City of New York
theme:
name: material
# hljs_languages:
# - yaml
# - json
# navigation_depth: 4
# sticky_navigation: False
# prev_next_buttons_location: both
plugins:
- techdocs-core
- autorefs
- mkdocstrings:
default_handler: python
handlers:
python:
setup_commands:
- import mkdocs_mkdocstrings_setup
options:
docstring_style: sphinx
# docstring_style: google
show_root_heading: true
inherited_members: false
members_order: source
# docstring_options:
show_source: true
show_if_no_docstring: true
show_signature_annotations: false
- macros:
module_name: mkdocs_macros_main
watch:
- myapp
#extra:
# markdown_extensions:
# - toc:
# anchorlink: True
# toc_depth: 4
###
# for testing mkautodoc:
###
# markdown_extensions:
# - admonition
# - codehilite
# - mkautodoc
# extra_css:
# - css/custom.css
nav:
- Home: 'index.md'
- 'Welcome and Caveat': welcome.md
- 'Documentation Revision History': changelog.md
- 'Preparing for the classes': preparing.md
- 'Motivation: Strategy and Architectural Standards': motivation.md
- 'Review: git, Python, JSON': review.md
- 'HTTP and REpresentational State Transfer (REST)': rest.md
- 'The {json:api} specification': jsonapi.md
- 'Building our DJA project': building.md
- 'Authorizing REST operations Using OAuth 2.0': oauth2.md
- 'Using django-oauth-toolkit as the AS': using_dot.md
- 'Using Columbia OAuth 2.0 as the AS': using_oauth2.md
- 'Modifying our DJA Project': modifying.md
- 'Another Modification: Add an Instructor Model and additional relationship': another1.md
- 'Database Backends': database.md
- 'Split Instructor model to be OneToOne with new Person model': another2.md
- 'Adding OIDC 1.0 Claims': oidc.md
- 'MkDocs Documentation': mkdocs.md
- 'Documenting the API with OAS 3': documenting-api.md
- 'Backstage developer portal': backstage.md
- 'Deploying to Production': deploying.md
- 'Using AWS API Gateway': aws_api_gw.md
- 'A Command Line Client': cli_client.md
- 'Help Wanted': help.md
- 'Code Reference':
- 'Models': api_models.md
- 'Views': api_views.md
- 'Serializers': api_serializers.md
- 'Schemas': api_schemas.md
- 'Tests': tests.md