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
|
site_name: Textual
markdown_extensions:
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- md_in_html
- admonition
- def_list
- meta
- footnotes
- toc:
permalink: true
baselevel: 1
- pymdownx.keys
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.superfences:
custom_fences:
- name: textual
class: textual
format: !!python/name:textual._doc.format_svg
- name: rich
class: rich
format: !!python/name:textual._doc.rich
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.snippets
- pymdownx.tabbed:
alternate_style: true
- pymdownx.snippets
- markdown.extensions.attr_list
- pymdownx.details
theme:
name: material
custom_dir: docs/custom_theme
logo: images/icons/logo light transparent.svg
features:
- navigation.tabs
- navigation.indexes
- navigation.tabs.sticky
- navigation.footer
- content.code.annotate
- content.code.copy
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
accent: purple
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
toggle:
icon: material/weather-night
name: Switch to light mode
plugins:
git-revision-date-localized:
search:
autorefs:
mkdocstrings:
default_handler: python
handlers:
python:
options:
modernize_annotations: false
show_symbol_type_heading: true
show_symbol_type_toc: true
show_signature_annotations: false
separate_signature: true
signature_crossrefs: true
merge_init_into_class: true
parameter_headings: true
show_root_heading: false
docstring_options:
ignore_init_summary: true
show_source: false
filters:
- "!^_"
- "^__init__$"
- "!^can_replace$"
# Hide some methods that Widget subclasses implement but that we don't want
# to be shown in the docs.
# This is then overridden in widget.md and app.md so that it shows in the
# base class.
- "!^compose$"
- "!^render$"
- "!^render_line$"
- "!^render_lines$"
- "!^get_content_width$"
- "!^get_content_height$"
- "!^compose_add_child$"
watch:
- mkdocs-common.yml
- mkdocs-nav.yml
- mkdocs-offline.yml
- mkdocs-online.yml
- src/textual
exclude:
glob:
- "**/_template.md"
- "snippets/*"
extra_css:
- stylesheets/custom.css
extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/textualizeio
name: textualizeio on Twitter
- icon: fontawesome/brands/github
link: https://github.com/textualize/textual/
name: Textual on Github
- icon: fontawesome/brands/discord
link: https://discord.gg/Enf6Z3qhVr
name: Textual Discord server
copyright: Copyright © Textualize, Inc
|
