-
Notifications
You must be signed in to change notification settings - Fork 22
/
Copy pathmkdocs.yml
131 lines (120 loc) · 4.06 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
# Project information
site_name: Lightbus
site_description: RPC & event system for Python 3
site_author: Adam Charnock
site_url: http://lightbus.org
# Repository
repo_name: GitHub
repo_url: https://github.com/adamcharnock/lightbus
theme:
name: material
palette:
primary: 'pink'
accent: 'indigo'
static_templates:
- 404.html
language: en
font:
text: Roboto
code: Roboto Mono
favicon: ""
logo:
icon: "\uE915"
feature:
tabs: true
nav:
- Home: index.md
- Tutorials:
- Overview: tutorial/index.md
- 1. Installation: tutorial/installation.md
- 2. Quick start: tutorial/quick-start.md
- 3. Worked example: tutorial/worked-example.md
- 4. Django & Lightbus: tutorial/django-and-lightbus.md
- Getting involved (even if you don't code): tutorial/getting-involved.md
- How to:
- Overview: howto/index.md
- Access your bus client: howto/access-your-bus-client.md
- Schedule recurring tasks: howto/schedule-recurring-tasks.md
- Run background tasks: howto/run-background-tasks.md
- Migrate from Celery to Lightbus: howto/migrate-from-celery-to-lightbus.md
- Write idempotent event handlers: howto/write-idempotent-event-handlers.md
- Use Lightbus for realtime metrics: howto/metrics.md
- Use Lightbus for event sourcing: howto/event-sourcing.md
- Modify Lightbus: howto/modify-lightbus.md
- Explanation:
- Overview: explanation/index.md
- Anatomy lesson: explanation/anatomy-lesson.md
- Services: explanation/services.md
- The bus: explanation/bus.md
- APIs: explanation/apis.md
- Remote procedure calls: explanation/rpcs.md
- Events: explanation/events.md
- Marshalling: explanation/marshalling.md
- Transports: explanation/transports.md
- Configuration: explanation/configuration.md
- Schema: explanation/schema.md
- Lightbus vs Celery: explanation/lightbus-vs-celery.md
- Architecture tips: explanation/architecture-tips.md
- Performance: explanation/performance.md
- Internal Architecture: explanation/internal-architecture.md
- Reference:
- Overview: reference/index.md
- APIs: reference/apis.md
- Remote procedure calls: reference/rpcs.md
- Events: reference/events.md
- Typing: reference/typing.md
- Configuration: reference/configuration.md
- Schema: reference/schema.md
- Command line use:
- run: reference/command-line-use/run.md
- inspect: reference/command-line-use/inspect.md
- shell: reference/command-line-use/shell.md
- dumpschema: reference/command-line-use/dumpschema.md
- dumpconfigschema: reference/command-line-use/dumpconfigschema.md
- Testing & Mocking: reference/testing-and-mocking.md
- Plugins: reference/plugins.md
- Plugin development: reference/plugins-development.md
- Transport configuration: reference/transport-configuration.md
- Protocols:
- Overview: reference/protocols/index.md
- RPC & Result Protocol (Redis): reference/protocols/rpc-and-result.md
- Event Protocol (Redis): reference/protocols/event.md
- Schema Protocol (Redis): reference/protocols/schema.md
- Release process: reference/release-process.md
- Authors: reference/authors.md
- Code of Conduct: reference/code-of-conduct.md
# Extensions
markdown_extensions:
- meta
- markdown.extensions.admonition
- markdown.extensions.codehilite:
guess_lang: false
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.toc:
permalink: true
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- markdown_include.include
google_analytics:
- 'UA-103655163-1'
- 'auto'
extra_css:
- 'static/stylesheets/extra.css'
- 'static/stylesheets/version-select.css'
extra_javascript:
- 'static/js/version-select.js'