forked from breatheco-de/apiv2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
145 lines (139 loc) · 5.49 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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
site_name: 4geeks
site_url: https://breathecode.herokuapp.com/
repo_name: breatheco-de/apiv2
repo_url: https://github.com/breatheco-de/apiv2
edit_uri: ""
theme:
name: 'material'
palette:
- scheme: 'default'
media: '(prefers-color-scheme: light)'
toggle:
icon: 'material/lightbulb'
name: "Switch to dark mode"
- scheme: 'slate'
media: '(prefers-color-scheme: dark)'
primary: 'blue'
toggle:
icon: 'material/lightbulb-outline'
name: 'Switch to light mode'
# features:
# - navigation.sections
# this define the order of menu
nav:
- "index.md"
- "4geeks-libraries.md"
- Getting started:
# which version of python install
- Set up:
- Works locally:
- "getting-started/setup/works-locally/introduction.md"
- "getting-started/setup/works-locally/devcontainer.md"
- "getting-started/setup/works-locally/on-host-os.md"
- Works on the cloud:
- "getting-started/setup/works-on-the-cloud/introduction.md"
- "getting-started/setup/works-on-the-cloud/gitpod.md"
- "getting-started/setup/works-on-the-cloud/codespaces.md"
- Essential:
- Django:
- "essential/django/introduction.md"
- "essential/django/urls.md"
- "essential/django/views.md"
- "essential/django/models.md"
- "essential/django/admin.md"
- "essential/django/commands.md"
- "essential/django/signals.md"
- "essential/django/templates.md"
- Django Rest Framework:
- "essential/django-rest-framework/introduction.md"
- "essential/django-rest-framework/views.md"
- "essential/django-rest-framework/serializers.md"
- "essential/django-rest-framework/validators.md"
- "essential/serpy.md"
- Celery:
- "essential/celery/introduction.md"
- "essential/celery/tasks.md"
- "essential/celery/calling.md"
- 4geeks:
- "essential/4geeks/actions.md"
- Services:
- essential/4geeks/services/introduction.md
- First-party:
- essential/4geeks/services/first-party/using-services.md
- essential/4geeks/services/first-party/writing-services.md
- essential/4geeks/services/first-party/token.md
- Advanced:
- Celery:
- "advanced/celery/application.md"
- "advanced/celery/canvas.md"
- "advanced/celery/periodic-tasks.md"
- "advanced/celery/routing.md"
- "advanced/celery/settings.md"
- Testing:
- "testing/running-tests.md"
- "testing/parametrize.md"
- Mixins:
- "bc": "testing/mixins/bc.md"
- "bc.fake": "testing/mixins/bc-fake.md"
- "bc.request": "testing/mixins/bc-request.md"
- "bc.database": "testing/mixins/bc-database.md"
- "bc.datetime": "testing/mixins/bc-datetime.md"
- "bc.format": "testing/mixins/bc-format.md"
- "bc.check": "testing/mixins/bc-check.md"
- "bc.cache": "testing/mixins/bc-cache.md"
- "bc.random": "testing/mixins/bc-random.md"
- Mocks:
- "testing/mocks/using-mocks.md"
- "testing/mocks/mock-requests.md"
- Workflows:
- "workflows/file-uploading.md"
- Infrastructure:
- "infrastructure/journal.md"
- "infrastructure/web.md"
- "infrastructure/infra-env.md"
- Studies:
- "infrastructure/studies/http-clients.md"
- "infrastructure/studies/django-workers.md"
- Not placed yet:
- "infrastructure/environment-variables.md"
- "installation/fixtures.md"
- Deployments:
- "deployment/environment-variables.md"
- "deployment/configuring-the-github-secrets.md"
- Apps:
- Monitoring:
- "apps/monitoring/introduction.md"
- "apps/monitoring/scripts.md"
- "apps/activities.md"
- "apps/admissions.md"
- Security:
- "security/introduction.md"
- "security/authentication-class.md"
- "security/capabilities.md"
- "security/schema-link.md"
- Services:
- Google Cloud:
- "services/google_cloud/google-cloud-functions.md"
- "services/google_cloud/storage.md"
- Slack:
- "services/slack integration/icons.md"
- Signals:
- "signals/quickstart.md"
plugins:
- search
- mkdocstrings:
handlers:
python:
setup_commands:
- import os
- import django
- os.environ.setdefault("DJANGO_SETTINGS_MODULE", "breathecode.settings")
- django.setup()
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
extra_css:
- css/custom.css