Skip to content

Commit e7d8375

Browse files
Ezra Halejmartinez-silabs
Ezra Hale
authored and
jmartinez-silabs
committed
Pull request project-chip#896: Feature/silabs 2.1.0 1.1 doc
Merge in WMN_TOOLS/matter from feature/silabs_2.1.0-1.1_doc to silabs Squashed commit of the following: commit 254c1ee081882d39f13b0bb67a6aa616dadec19f Author: Ezra Hale <ezra.hale@silabs.com> Date: Tue Jun 20 09:16:22 2023 -0400 adding drop arrow commit 6ab152ac153a5151d1d67b91fe945312860ef88c Author: Ezra Hale <ezra.hale@silabs.com> Date: Tue Jun 20 09:02:56 2023 -0400 making a couple minor edits commit d6c3226fb594a1f292bd6b25e1aafbb7d986c0b7 Author: Ezra Hale <ezra.hale@silabs.com> Date: Mon Jun 19 09:35:31 2023 -0400 update new features page to include more information ... and 9 more commits
1 parent 506233d commit e7d8375

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+1486
-269
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ docs/html
5555

5656
# Documentation
5757
docs/_build
58+
docs/silabs/_build
59+
docs/silabs/_dox
5860

5961
# VSCode java extensions
6062
.project

‎docs/silabs/DOC_STANDARD.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ $ this is a highlighted command
2222
```
2323

2424
```shell
25-
$ if there is a second line it has it's own entry
25+
$ if there is a second line it has its own entry
2626
```
2727
2828
```shell

‎docs/silabs/Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/silabs/NEW_FEATURES.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# Silicon Labs Matter New Features
22

3-
## New Features for v2.0.0-1.1
3+
## New Features for v2.1.0-1.1
4+
- ### Update to GSDK Version 4.2.3
5+
6+
The GSDK Version 4.2.3 includes important security enhancements for the Open Thread Stack which in turn updates all Matter over Thread implementations.
47

5-
---
8+
## New Features for v2.0.0-1.1
69

710
## Matter Intermittently Connected Devices (ICD / Sleepy) Improvements
811
- ### Expose the API for a device to change the max interval in a subscription request

‎docs/silabs/OVERVIEW.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,7 @@ This content covers
1111
- Software and Hardware prerequisites for working with Silicon Labs Matter.
1212
- [Thread demo and development information](./thread/DEMO_OVERVIEW.md)
1313
- [Wi-Fi demo and development information](./wifi/DEMO_OVERVIEW.md)
14-
- [Getting started with Unify Matter Bridge](../../silabs_examples/unify-matter-bridge/readme_user.md#running-the-matter-bridge)
14+
- [Getting started with Unify Matter Bridge](./unify/readme_user.md)
1515
- Information on using [VSCode and the provided container environment](./dev/vscode/SETUP.md)
1616
- A list of useful reference guides
1717
- Frequently asked questions about both Thread and Wi-Fi development
18-
19-
----
20-
21-
[Table of Contents](./README.md)

‎docs/silabs/_static/custom_styles.css

+207
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
body {
2+
font-family: 'Open Sans', Helvetica, Arial, sans-serif
3+
}
4+
5+
.wy-nav-content {
6+
max-width: none;
7+
}
8+
9+
.wy-nav-content-wrap {
10+
background: none;
11+
}
12+
13+
.wy-side-nav-search {
14+
background: #0086D9;
15+
padding: 0;
16+
height: 174px;
17+
}
18+
19+
.wy-side-nav-search input[type=text] {
20+
border-radius: 0;
21+
}
22+
23+
.wy-side-nav-search>a {
24+
color: transparent;
25+
height: 110px;
26+
}
27+
28+
.wy-side-nav-search .wy-dropdown>a.icon img.logo,
29+
.wy-side-nav-search>a.icon img.logo {
30+
margin-top: -0.15em;
31+
margin-bottom: 15px;
32+
}
33+
34+
.wy-side-nav-search>a:hover {
35+
background: none;
36+
}
37+
38+
.icon-home::after {
39+
content: "Matter";
40+
font-family: 'Open Sans', Helvetica, Arial, sans-serif;
41+
color: #fff;
42+
font-weight: 300;
43+
}
44+
45+
.wy-nav-side {
46+
background: #363636;
47+
}
48+
49+
#rtd-search-form input {
50+
border: none;
51+
padding: 7px 12px;
52+
}
53+
54+
.wy-menu-vertical a {
55+
color: #c8c8c8;
56+
text-decoration: none;
57+
font-family: 'Roboto', sans-serif;
58+
font-weight: bold;
59+
}
60+
61+
.wy-menu-vertical li a {
62+
line-height: 24px;
63+
font-weight: 300 !important;
64+
color: #a9a9a9 !important;
65+
border: none !important;
66+
}
67+
68+
.wy-menu-vertical a:hover {
69+
/* background-color: #414141; */
70+
text-decoration: underline;
71+
}
72+
73+
.wy-menu-vertical li>a.current {
74+
border-left: 4px solid #D91E2A !important;
75+
}
76+
77+
.wy-menu-vertical li.toctree-l1>a:hover,
78+
.wy-menu-vertical li.toctree-l1.current>a,
79+
.wy-menu-vertical li.toctree-l2>a {
80+
background-color: #414141;
81+
}
82+
83+
.wy-menu-vertical li.toctree-l2>a:hover,
84+
.wy-menu-vertical li.toctree-l2.current>a,
85+
.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a {
86+
background-color: #4b4b4b;
87+
}
88+
89+
.wy-menu-vertical li.toctree-l2.current li.toctree-l3>a:hover,
90+
.wy-menu-vertical li.toctree-l3.current>a,
91+
.wy-menu-vertical li.toctree-l3.current li.toctree-l4>a {
92+
background-color: #555;
93+
}
94+
95+
.wy-menu-vertical li.toctree-l2.current li.toctree-l3.current li.toctree-l4>a:hover,
96+
.wy-menu-vertical li.toctree-l4.current>a,
97+
.wy-menu-vertical li.toctree-l4.current li.toctree-l5>a {
98+
background-color: #5f5f5f;
99+
}
100+
101+
.wy-menu-vertical li button.toctree-expand {
102+
float: right;
103+
}
104+
105+
.wy-menu-vertical li button.toctree-expand:before,
106+
.wy-menu-vertical li button.toctree-expand:before {
107+
content: url('droparrow.svg');
108+
transform: rotate(-90deg);
109+
transition: 100ms;
110+
line-height: 25px;
111+
width: 15px;
112+
}
113+
114+
.wy-menu-vertical li.current>a button.toctree:before,
115+
.wy-menu-vertical li.on a button.toctree:before,
116+
.wy-menu-vertical li.current>a button.toctree-expand:before,
117+
.wy-menu-vertical li.on a button.toctree-expand:before {
118+
content: url('droparrow.svg');
119+
transform: rotate(0deg);
120+
}
121+
122+
.github-button {
123+
bottom: 10px;
124+
margin-left: 75px;
125+
position: fixed;
126+
}
127+
128+
.wy-side-scroll {
129+
height: calc(100% - 20px);
130+
}
131+
132+
/* override table no-wrap */
133+
.wy-table-responsive table td, .wy-table-responsive table th {
134+
white-space: normal;
135+
}
136+
137+
138+
footer {
139+
text-align: center;
140+
}
141+
142+
footer hr {
143+
margin: 20px 0;
144+
}
145+
146+
h1 {
147+
margin: 0.67em 0;
148+
font-weight: 300;
149+
font-size: 42px;
150+
}
151+
152+
h2 {
153+
margin: 48px 0 32px 0;
154+
font-weight: 600;
155+
font-size: 26px;
156+
}
157+
158+
h3 {
159+
font-weight: 700;
160+
font-size: 17px;
161+
}
162+
163+
.wy-menu-vertical li a {
164+
padding-right: 2px !important;
165+
}
166+
167+
.wy-menu-vertical li.current>a {
168+
padding-right: 10px !important;
169+
}
170+
171+
.error-message {
172+
color: red;
173+
line-height: 40px;
174+
text-align: center;
175+
}
176+
177+
.dsk-value {
178+
line-height: 40px;
179+
margin-right: 20px;
180+
}
181+
182+
#qr-reader {
183+
width: 50%;
184+
margin: auto;
185+
}
186+
187+
.dsk-container {
188+
visibility: hidden;
189+
margin: auto;
190+
width: 50%;
191+
margin-top: 30px;
192+
line-height: 40px;
193+
}
194+
195+
.dsk-container>div {
196+
text-align: center;
197+
}
198+
199+
video {
200+
width: inherit !important;
201+
}
202+
203+
.flip video {
204+
transform: rotateY(180deg);
205+
-webkit-transform: rotateY(180deg);
206+
-moz-transform: rotateY(180deg);
207+
}

‎docs/silabs/_static/droparrow.svg

+1
Loading

‎docs/silabs/_templates/footer.html

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<footer>
2+
<hr/>
3+
<p>{{ copyright }}</p>
4+
</footer>

‎docs/silabs/conf.py

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'Matter'
10+
copyright = 'Copyright © 2023 Silicon Laboratories. All rights reserved.'
11+
author = 'Silicon Labs'
12+
release = '2.1.0-1.1'
13+
version = '2.1.0-1.1'
14+
15+
16+
# -- General configuration ---------------------------------------------------
17+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
18+
19+
extensions = ['myst_parser',
20+
"sphinx_rtd_theme",
21+
"sphinx_tabs.tabs"]
22+
23+
24+
source_suffix = ['.rst', '.md']
25+
templates_path = ['_templates']
26+
exclude_patterns = ['_build',
27+
'Thumbs.db',
28+
'.DS_Store',
29+
'README.md',
30+
'DOC_STANDARD.md',
31+
'unify/readme_chip_tool_testing.md']
32+
33+
34+
35+
# -- Options for HTML output -------------------------------------------------
36+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
37+
38+
html_theme = 'sphinx_rtd_theme'
39+
html_theme_options = {
40+
'analytics_id': 'G-XXXXXXXXXX', # Provided by Google in your dashboard
41+
'analytics_anonymize_ip': False,
42+
'logo_only': False,
43+
'display_version': True,
44+
'prev_next_buttons_location': 'bottom',
45+
'style_external_links': False,
46+
'vcs_pageview_mode': '',
47+
'style_nav_header_background': '#3b82f6',
48+
# Toc options
49+
'collapse_navigation': True,
50+
'sticky_navigation': True,
51+
'navigation_depth': 3,
52+
'includehidden': True,
53+
'titles_only': False
54+
}
55+
html_static_path = ['_static']
56+
html_favicon = 'favicon.ico'
57+
html_logo = 'logo.png'
58+
html_css_files = ['custom_styles.css']
59+
myst_enable_extensions = [
60+
"amsmath",
61+
"attrs_inline",
62+
"colon_fence",
63+
"deflist",
64+
"dollarmath",
65+
"fieldlist",
66+
"html_admonition",
67+
"html_image",
68+
"linkify",
69+
"replacements",
70+
"smartquotes",
71+
"strikethrough",
72+
"substitution",
73+
"tasklist",
74+
]
75+
myst_heading_anchors = 4
76+
77+
# Setup the breathe extension
78+
breathe_projects = {
79+
"My Project": "./_doxygen/xml"
80+
}
81+
breathe_default_project = "My Project"
82+
83+
# Setup the exhale extension
84+
exhale_args = {
85+
# These arguments are required
86+
"containmentFolder": "./dox",
87+
"rootFileName": "index.rst",
88+
"doxygenStripFromPath": "..",
89+
# Heavily encouraged optional argument (see docs)
90+
"rootFileTitle": "Library API",
91+
# Suggested optional arguments
92+
"createTreeView": True,
93+
# TIP: if using the sphinx-bootstrap-theme, you need
94+
# "treeViewIsBootstrap": True,
95+
"exhaleExecutesDoxygen": True,
96+
"exhaleDoxygenStdin": "INPUT = ./src"
97+
}
98+
99+
# Tell sphinx what the primary language being documented is.
100+
primary_domain = 'cpp'
101+
102+
# Tell sphinx what the pygments highlight language should be.
103+
highlight_language = 'cpp'

‎docs/silabs/dev/DEV.md

-1
This file was deleted.

0 commit comments

Comments
 (0)