Repository navigation
Expand file tree
/
Copy pathproperdocs.yml
More file actions
99 lines (92 loc) · 3.04 KB
/
Copy pathproperdocs.yml
File metadata and controls
99 lines (92 loc) · 3.04 KB
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
site_name: Pybricks Tools
site_description: A service, library and CLI for talking to Pybricks hubs
site_url: https://pybricks.com/pybricks-tools/
repo_url: https://github.com/pybricks/pybricks-tools
edit_uri: edit/main/docs/
copyright: Copyright © The Pybricks Authors
theme:
name: material
# The Pybricks mark, and the app icon as the favicon. Linked from
# pybricks-code rather than kept here, so that this repository holds no copy
# of the logos. Pinned to a release tag: a file moved on its main branch
# would otherwise take the site's logo with it.
logo: https://raw.githubusercontent.com/pybricks/pybricks-code/v2.2.0/src/editor/logo.svg
favicon: https://raw.githubusercontent.com/pybricks/pybricks-code/v2.2.0/src/about/icon.svg
icon:
repo: fontawesome/brands/github
features:
- navigation.sections
- navigation.indexes
- navigation.top
- content.code.copy
- search.suggest
palette:
# "custom" is Material's own name for a palette it does not ship; the
# colours are in docs/assets/pybricks.css.
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
toggle: { icon: material/brightness-7, name: Switch to dark mode }
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
toggle: { icon: material/brightness-4, name: Switch to light mode }
extra_css:
- assets/pybricks.css
extra:
social:
- icon: fontawesome/solid/house
link: https://pybricks.com
name: Pybricks
- icon: fontawesome/brands/github
link: https://github.com/pybricks/pybricks-tools
name: This project on GitHub
- icon: fontawesome/solid/comments
link: https://github.com/pybricks/support/discussions
name: Ask a question
plugins:
- search
- gen-files:
scripts:
- docs/gen_api_pages.py
- docs/gen_cli_page.py
- literate-nav:
nav_file: SUMMARY.md
- mkdocstrings:
handlers:
python:
options:
docstring_style: google
# A constructor's parameters are how the class is built, so
# they belong on the class's page rather than on one of their
# own called __init__.
merge_init_into_class: true
show_source: false
show_root_heading: true
separate_signature: true
signature_crossrefs: true
inventories:
- https://docs.python.org/3/objects.inv
- https://anyio.readthedocs.io/en/stable/objects.inv
markdown_extensions:
- admonition
- pymdownx.snippets:
base_path: [.]
check_paths: true
- pymdownx.details
- pymdownx.keys
- pymdownx.superfences
- toc: { permalink: true }
nav:
- Home: index.md
- Command line:
- cli/index.md
- Commands: cli/commands.md
- Several files: cli/multi-file.md
- Environment variables: cli/environment.md
- Project file: cli/pyproject.md
- API reference: reference/
- How it works: design.md
- Contributing: contributing.md