Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Sphinx documentation framework #19950

Closed
wants to merge 14 commits into from
Closed

Add Sphinx documentation framework #19950

wants to merge 14 commits into from

Conversation

gautesl
Copy link
Contributor

@gautesl gautesl commented Jun 24, 2022 •
edited
Loading

Problem

This PR is a follow-up to the doc framework meeting on February 13, 2022. Goals discussed at the meeting for the doc framework setup:

  • Ensure global structure for docs (host the available guides in a structured way on one website, set up doc framework)
  • Reduce content duplication (make it possible to organize pages into a coherent platform instead of single pages with duplicated content on github)
  • Foster contribution and collaboration (make it easier to navigate pages and search for content from the one website)
  • Use reliable platform solutions and best practices (use MyST and github.io, integrate CI deployment of the doc framework)

Change overview

This PR introduces Sphinx as a documentation framework, and includes a workflow that builds the documentation and deploy the generated html to an external repository where it is served by github.io (Currently on hold).

The PR consists of:

  • New files in the docs folder setting up the needed files for using MyST with Sphinx, as well as a prototype ToC-tree.
  • Extensions for running doxygen and transforming markdown files to be compatible with MyST.
  • Fixes for existing broken links within the documentation files.
  • Changes to syntax that does not render within MyST/Sphinx.
  • A workflow file that triggers on push to master, which builds the documentation and deploy it to an external repository where they are served by github.io.

A preview of the generated page can be seen based off my fork here: https://gautesl.github.io/connectedhomeip/docs/
I will keep the page up while this PR is open.

Differences when writing docs for Sphinx

Adding files to Sphinx

Currently, everything in /docs and all images and .md files in /examples are part of the Sphinx documentation. Everything picked up by Sphinx must be part of the ToC-tree, but in the case that a file should be part of the documentation but not part of the ToC-tree, the following can be put on top of the file:

---
orphan: true
---

Note that this will not render as hidden on GitHub.

For a file to be a part of the ToC-tree, it must be referenced by another file with the following syntax:

```{toctree}

my_new_file
```

See docs/index.md for the root of the ToC-tree.

Should a file within /docs or /examples not be part of the documentation, it must be added to the exclude_patterns list located in /docs/conf.py.

HTML

Nested HTML tags in markdown files will not render. If nesting is necessary to e.g. centre an image, the following syntax can be used (note that this will not render on GitHub):

```{image} path/to/image.png
:alt: sometext
:align: center
```

For more information, see the official documentation

Links

Some existing links no longer works when used within Sphinx. To avoid rewriting all existing documentation and make the links renderable both on Sphinx and GitHub, the broken links are transformed upon building with the following rules:

  • All hyperlinks works as usual.
  • Most other links will work as usual, but links to sections within another page are removed
    • [link](my/page#my_section) becomes [link](my/page)
  • Links to anything but .md, .png, .jpg and .svg files are transformed into external links to the GitHub location of that file
    • More file-extensions can be added in conf.py under external_content_link_extensions
  • Links to any file in the src or .vscode folders are transformed into external links to the GitHub location of that file.
    • More folders can be added in conf.py under external_content_link_repositories if you need to link to a file not included in the ToC-tree.
  • Using the <a name="my-anchor"></a> pattern no longer works.
    • The normal same-page section links still works as usual provided the correct section anchor is used
      • e.g [See my section](#my-section) in combination with #### My Section.
    • Direct links to sections on another page in Sphinx can be created using the following pattern (note that this will not render as hidden on GitHub):
    [This link works on all pages](my-important-anchor)

(my-important-anchor)=
## Important!

For more information, see the official documentation

Emojis

Emojis written on the form :heavy_check_mark: does not render in Sphinx. Where these would be used, the unicode version of the emoji should be used directly instead.

Final notes

  • This PR introduces the Sphinx framework, and produces a prototype. The contents of the documentation should be expanded upon as needed.
  • The docbuild.yaml workflow currently does not deploy the generated html anywhere. This will be changed when a destination is ready.
  • Most README.md files include a table of contents at the very start. If desired, these may be removed in the future, as Sphinx automatically maintains a ToC for every page.

Testing

  • This PR does not affect any source code.
  • Building with Sphinx will fail if it contains any broken internal links.
  • External links can be manually checked with make linkcheck in the docs folder.

@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation github workflows labels Jun 24, 2022
@CLAassistant
Copy link

CLAassistant commented Jun 24, 2022 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@LuDuda
Copy link
Contributor

LuDuda commented Aug 12, 2022

@woody-apple please take a look on this PR. After getting a green light, we'll rebase it to current main.

@andy31415
Copy link
Contributor

/rebase

greg-fer and others added 14 commits August 23, 2022 09:00
@greg-fer @gautesl
doc: add doc portal basics
2e983eb 
Initial commit for the doc portal framework.

Signed-off-by: Grzegorz Ferenc <[email protected]>
@greg-fer @gautesl
doc: add example sections
786fe75 
Added sections to Examples doc container page.
Restructured Guides landing page.

Signed-off-by: Grzegorz Ferenc <[email protected]>
@greg-fer @gautesl
doc: fix MD headers in example readmies
2d81ec5 
Fixed Markdown header levels to improve visibility for Examples
container page.

Signed-off-by: Grzegorz Ferenc <[email protected]>
@gautesl
doc: fix sphinx build warnings
ddb7b5c 
Fixed or removed all warnings from Sphinx when building.
Fixes include:
- Linking errors
- Typos
- ToC tree errors
- Adding MyST configuration data
- Modify the external_content extension to allow syntax that
  renders on both GitHub and Sphinx

Signed-off-by: Gaute Svanes Lunde <[email protected]>
@gautesl
doc: changed ✔️ to ascii symbol
56773cb 
Changed the GitHub rendered emoji ✔️ to the
ascii symbol ✔ so that it renders with Sphinx.

Signed-off-by: Gaute Svanes Lunde <[email protected]>
@gautesl
workflow: add docbuild workflow
0ed4c6e 
Add a workflow for building the documentation with Sphinx and
deploy the generated html to the `gh-pages` branch.

Signed-off-by: Gaute Svanes Lunde <[email protected]>
@gautesl
sphinx: remove doxygen and add landing page
6fb27b9 
The incomplete API page has been removed, and doxygen disabled.
The landing page is now set to the top level `README.md`, and
the external_content extension is updated to transform specific
prefixes and links to folders into external links.

Signed-off-by: Gaute Svanes Lunde <[email protected]>
@gautesl
workflows: expand markdown fences in spellchecker
98667c7 
Expand the markdown fences to include MyST for Sphinx syntax
like the following:

```{include} my/file.md
```

Signed-off-by: Gaute Svanes Lunde <[email protected]>
@gautesl
workflow: publish Sphinx output to external repo
fe7e1c9 
Push the Sphinx generated documentation output to the
connectedhomeip-doc repository to be used by github.io.

Signed-off-by: Gaute Svanes Lunde <[email protected]>
@gautesl
sphinx: revert doxygen to previous state
4f7fed1 
No longer include doxygen, Breathe or doxyrunner in the Sphinx
build process.

Signed-off-by: Gaute Svanes Lunde <[email protected]>
@gautesl
workflows: remove sphinx output deployment
0da5d60 
Removed the deployment step so that the current doxygen
generated API is not overwritten. The deployment step should be
reintroduced with another repository and another deployment key
when ready.

A link to the existing API has been added to the documentation.

Signed-off-by: Gaute Svanes Lunde <[email protected]>
@gautesl
doc: sphinx: rebase on master
8a8c73e 
Signed-off-by: Gaute Svanes Lunde <[email protected]>
@gautesl
doc: sphinx: rebase
2fca7ac 
Signed-off-by: Gaute Svanes Lunde <[email protected]>
@gautesl
workflows: Overwrite Doxygen with Sphinx docs
6504487 
Push the Sphinx-generated html to
project-chip/connectedhomeip-doc, overwriting the current
Doxygen documentation.

Signed-off-by: Gaute Svanes Lunde <[email protected]>
@gautesl gautesl force-pushed the doc_build_workflow branch from 86a172b to 6504487 Compare August 23, 2022 12:23
@github-actions
Copy link

github-actions bot commented Aug 23, 2022 •
edited
Loading

PR #19950: Size comparison from 48f87f3 to 6504487

Increases (5 builds for nrfconnect, psoc6, telink)
platform target config section 48f87f3 6504487 change % change
nrfconnect all-clusters-minimal-app nrf52840dk_nrf52840 text 803140 803144 4 0.0
pump-controller-app nrf52840dk_nrf52840 text 739412 739416 4 0.0
psoc6 all-clusters cy8ckit_062s2_43012 .debug_info 26644545 26644546 1 0.0
lock cy8ckit_062s2_43012 .debug_info 22200965 22200967 2 0.0
telink lighting-app tlsr9518adk80d text 589408 589410 2 0.0
Decreases (2 builds for esp32, psoc6)
platform target config section 48f87f3 6504487 change % change
esp32 all-clusters-app c3devkit (read only) 1031270 1031268 -2 -0.0
.flash.text 1031270 1031268 -2 -0.0
psoc6 all-clusters-minimal cy8ckit_062s2_43012 .debug_info 26381241 26381240 -1 -0.0
Full report (57 builds for bl602, cc13x2_26x2, cyw30739, efr32, esp32, k32w, linux, mbed, nrfconnect, psoc6, telink)
platform target config section 48f87f3 6504487 change % change
bl602 lighting-app bl602 (read/write) 1383930 1383930 0 0.0
.bss 120266 120266 0 0.0
.data 4480 4480 0 0.0
.text 1051096 1051096 0 0.0
bl602+rpc (read/write) 1429586 1429586 0 0.0
.bss 127706 127706 0 0.0
.data 4600 4600 0 0.0
.text 1082856 1082856 0 0.0
cc13x2_26x2 all-clusters-app LP_CC2652R7 (read only) 673035 673035 0 0.0
(read/write) 178460 178460 0 0.0
.bss 74388 74388 0 0.0
.data 3372 3372 0 0.0
.rodata 88835 88835 0 0.0
.text 583884 583884 0 0.0
all-clusters-minimal-app LP_CC2652R7 (read only) 637755 637755 0 0.0
(read/write) 157948 157948 0 0.0
.bss 73660 73660 0 0.0
.data 3372 3372 0 0.0
.rodata 77979 77979 0 0.0
.text 559452 559452 0 0.0
lock-ftd LP_CC2652R7 (read only) 674151 674151 0 0.0
(read/write) 167552 167552 0 0.0
.bss 71484 71484 0 0.0
.data 3296 3296 0 0.0
.rodata 76671 76671 0 0.0
.text 597000 597000 0 0.0
lock-mtd LP_CC2652R7 (read only) 656911 656911 0 0.0
(read/write) 180480 180480 0 0.0
.bss 67172 67172 0 0.0
.data 3296 3296 0 0.0
.rodata 101767 101767 0 0.0
.text 554664 554664 0 0.0
pump-app LP_CC2652R7 (read only) 684823 684823 0 0.0
(read/write) 157688 157688 0 0.0
.bss 71524 71524 0 0.0
.data 3296 3296 0 0.0
.rodata 89959 89959 0 0.0
.text 594380 594380 0 0.0
pump-controller-app LP_CC2652R7 (read only) 669331 669331 0 0.0
(read/write) 173300 173300 0 0.0
.bss 71644 71644 0 0.0
.data 3292 3292 0 0.0
.rodata 85515 85515 0 0.0
.text 583336 583336 0 0.0
shell LP_CC2652R7 (read only) 665718 665718 0 0.0
(read/write) 181296 181296 0 0.0
.bss 76708 76708 0 0.0
.data 3376 3376 0 0.0
.rodata 85782 85782 0 0.0
.text 579620 579620 0 0.0
cyw30739 light cyw930739m2evb_01 (read/write) 586754 586754 0 0.0
.app_xip_area 463412 463412 0 0.0
.bss 65776 65776 0 0.0
.data 744 744 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
lock cyw930739m2evb_01 (read/write) 592546 592546 0 0.0
.app_xip_area 464420 464420 0 0.0
.bss 70560 70560 0 0.0
.data 748 748 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
ota-requestor-no-progress-logging cyw930739m2evb_01 (read/write) 599682 599682 0 0.0
.app_xip_area 477060 477060 0 0.0
.bss 65088 65088 0 0.0
.data 716 716 0 0.0
.rodata 0 0 0 0.0
.text 112 112 0 0.0
efr32 lighting-app BRD4161A (read/write) 1107636 1107636 0 0.0
.bss 136332 136332 0 0.0
.data 2072 2072 0 0.0
.text 969212 969212 0 0.0
BRD4161A+rpc (read/write) 971588 971588 0 0.0
.bss 150844 150844 0 0.0
.data 2252 2252 0 0.0
.text 818468 818468 0 0.0
BRD4161A+rs911x (read/write) 1000248 1000248 0 0.0
.bss 169088 169088 0 0.0
.data 2056 2056 0 0.0
.text 829084 829084 0 0.0
lock-app BRD4161A+wf200 (read/write) 1149420 1149420 0 0.0
.bss 152168 152168 0 0.0
.data 2064 2064 0 0.0
.text 995168 995168 0 0.0
window-app BRD4161A (read/write) 1098932 1098932 0 0.0
.bss 137772 137772 0 0.0
.data 2096 2096 0 0.0
.text 959044 959044 0 0.0
esp32 all-clusters-app c3devkit (read only) 1031270 1031268 -2 -0.0
(read/write) 1489610 1489610 0 0.0
.dram0.bss 71136 71136 0 0.0
.dram0.data 14600 14600 0 0.0
.flash.rodata 218440 218440 0 0.0
.flash.text 1031270 1031268 -2 -0.0
.iram0.text 62902 62902 0 0.0
m5stack (read only) 1084387 1084387 0 0.0
(read/write) 491544 491544 0 0.0
.dram0.bss 76640 76640 0 0.0
.dram0.data 34144 34144 0 0.0
.flash.rodata 248764 248764 0 0.0
.flash.text 1079003 1079003 0 0.0
.iram0.text 123267 123267 0 0.0
k32w light k32w0+release (read/write) 646676 646676 0 0.0
.bss 70400 70400 0 0.0
.data 2068 2068 0 0.0
.text 571480 571480 0 0.0
lock k32w0+release (read/write) 704220 704220 0 0.0
.bss 70864 70864 0 0.0
.data 2076 2076 0 0.0
.text 628552 628552 0 0.0
linux all-clusters-app debug (read only) 3038505 3038505 0 0.0
(read/write) 156024 156024 0 0.0
.bss 61920 61920 0 0.0
.data 2096 2096 0 0.0
.data.rel.ro 85624 85624 0 0.0
.dynamic 608 608 0 0.0
.got 4568 4568 0 0.0
.init 27 27 0 0.0
.init_array 1168 1168 0 0.0
.rodata 274667 274667 0 0.0
.text 2584690 2584690 0 0.0
all-clusters-minimal-app debug (read only) 2874369 2874369 0 0.0
(read/write) 147624 147624 0 0.0
.bss 61152 61152 0 0.0
.data 2064 2064 0 0.0
.data.rel.ro 78120 78120 0 0.0
.dynamic 608 608 0 0.0
.got 4488 4488 0 0.0
.init 27 27 0 0.0
.init_array 1152 1152 0 0.0
.rodata 274859 274859 0 0.0
.text 2423138 2423138 0 0.0
bridge-app debug+rpc (read only) 2373017 2373017 0 0.0
(read/write) 127584 127584 0 0.0
.bss 50656 50656 0 0.0
.data 3600 3600 0 0.0
.data.rel.ro 67464 67464 0 0.0
.dynamic 608 608 0 0.0
.got 4392 4392 0 0.0
.init 27 27 0 0.0
.init_array 824 824 0 0.0
.rodata 203496 203496 0 0.0
.text 2006898 2006898 0 0.0
chip-tool debug (read only) 10877649 10877649 0 0.0
(read/write) 651328 651328 0 0.0
.bss 25240 25240 0 0.0
.data 3266 3266 0 0.0
.data.rel.ro 616312 616312 0 0.0
.dynamic 608 608 0 0.0
.got 5096 5096 0 0.0
.init 27 27 0 0.0
.init_array 768 768 0 0.0
.rodata 562901 562901 0 0.0
.text 8808020 8808020 0 0.0
chip-tool-ipv6only arm64 (read only) 10259676 10259676 0 0.0
(read/write) 699137 699137 0 0.0
.bss 33297 33297 0 0.0
.data 3272 3272 0 0.0
.data.rel.ro 643824 643824 0 0.0
.dynamic 560 560 0 0.0
.got 13784 13784 0 0.0
.init 24 24 0 0.0
.init_array 192 192 0 0.0
.rodata 493564 493564 0 0.0
.text 8127972 8127972 0 0.0
lighting-app debug+rpc (read only) 2597849 2597849 0 0.0
(read/write) 130304 130304 0 0.0
.bss 49760 49760 0 0.0
.data 2096 2096 0 0.0
.data.rel.ro 72488 72488 0 0.0
.dynamic 608 608 0 0.0
.got 4392 4392 0 0.0
.init 27 27 0 0.0
.init_array 920 920 0 0.0
.rodata 220400 220400 0 0.0
.text 2206546 2206546 0 0.0
lock-app debug (read only) 2580945 2580945 0 0.0
(read/write) 125512 125512 0 0.0
.bss 48288 48288 0 0.0
.data 1712 1712 0 0.0
.data.rel.ro 69512 69512 0 0.0
.dynamic 608 608 0 0.0
.got 4464 4464 0 0.0
.init 27 27 0 0.0
.init_array 896 896 0 0.0
.rodata 237360 237360 0 0.0
.text 2176930 2176930 0 0.0
ota-provider-app debug (read only) 2358105 2358105 0 0.0
(read/write) 118976 118976 0 0.0
.bss 47808 47808 0 0.0
.data 1936 1936 0 0.0
.data.rel.ro 63336 63336 0 0.0
.dynamic 608 608 0 0.0
.got 4488 4488 0 0.0
.init 27 27 0 0.0
.init_array 760 760 0 0.0
.rodata 209336 209336 0 0.0
.text 1985298 1985298 0 0.0
ota-requestor-app debug (read only) 2523705 2523705 0 0.0
(read/write) 127384 127384 0 0.0
.bss 50368 50368 0 0.0
.data 2304 2304 0 0.0
.data.rel.ro 68744 68744 0 0.0
.dynamic 608 608 0 0.0
.got 4480 4480 0 0.0
.init 27 27 0 0.0
.init_array 848 848 0 0.0
.rodata 216160 216160 0 0.0
.text 2134930 2134930 0 0.0
shell debug (read only) 2606809 2606809 0 0.0
(read/write) 142144 142144 0 0.0
.bss 57832 57832 0 0.0
.data 1264 1264 0 0.0
.data.rel.ro 77224 77224 0 0.0
.dynamic 608 608 0 0.0
.got 4136 4136 0 0.0
.init 27 27 0 0.0
.init_array 1040 1040 0 0.0
.rodata 234770 234770 0 0.0
.text 2213618 2213618 0 0.0
thermostat-no-ble arm64 (read only) 2357300 2357300 0 0.0
(read/write) 141825 141825 0 0.0
.bss 55345 55345 0 0.0
.data 1672 1672 0 0.0
.data.rel.ro 75984 75984 0 0.0
.dynamic 560 560 0 0.0
.got 5048 5048 0 0.0
.init 24 24 0 0.0
.init_array 408 408 0 0.0
.rodata 140620 140620 0 0.0
.text 1978960 1978960 0 0.0
tv-app debug (read only) 3182297 3182297 0 0.0
(read/write) 257968 257968 0 0.0
.bss 167480 167480 0 0.0
.data 4736 4736 0 0.0
.data.rel.ro 79184 79184 0 0.0
.dynamic 608 608 0 0.0
.got 4856 4856 0 0.0
.init 27 27 0 0.0
.init_array 1072 1072 0 0.0
.rodata 259016 259016 0 0.0
.text 2733538 2733538 0 0.0
tv-casting-app debug (read only) 5502833 5502833 0 0.0
(read/write) 160464 160464 0 0.0
.bss 51480 51480 0 0.0
.data 2432 2432 0 0.0
.data.rel.ro 100120 100120 0 0.0
.dynamic 608 608 0 0.0
.got 4776 4776 0 0.0
.init 27 27 0 0.0
.init_array 1040 1040 0 0.0
.rodata 344209 344209 0 0.0
.text 4887010 4887010 0 0.0
mbed all-clusters-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2526916 2526916 0 0.0
.bss 222848 222848 0 0.0
.data 5584 5584 0 0.0
.text 1489532 1489532 0 0.0
all-clusters-minimal-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2476344 2476344 0 0.0
.bss 222120 222120 0 0.0
.data 5560 5560 0 0.0
.text 1438940 1438940 0 0.0
lighting-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2463244 2463244 0 0.0
.bss 216708 216708 0 0.0
.data 5840 5840 0 0.0
.text 1425860 1425860 0 0.0
lock-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2454536 2454536 0 0.0
.bss 215044 215044 0 0.0
.data 5872 5872 0 0.0
.text 1417180 1417180 0 0.0
pigweed-app CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 1153932 1153932 0 0.0
.bss 10944 10944 0 0.0
.data 4520 4520 0 0.0
.text 117316 117316 0 0.0
shell CY8CPROTO_062_4343W+release (read only) 6224 6224 0 0.0
(read/write) 2412276 2412276 0 0.0
.bss 215040 215040 0 0.0
.data 5736 5736 0 0.0
.text 1374892 1374892 0 0.0
nrfconnect all-clusters-app nrf52840dk_nrf52840 (read/write) 1180799 1180799 0 0.0
bss 143745 143745 0 0.0
rodata 143360 143360 0 0.0
text 814736 814736 0 0.0
all-clusters-minimal-app nrf52840dk_nrf52840 (read/write) 1159883 1159883 0 0.0
bss 142972 142972 0 0.0
rodata 134948 134948 0 0.0
text 803140 803144 4 0.0
light-switch-app nrf52840dk_nrf52840 (read/write) 1092311 1092311 0 0.0
bss 135357 135357 0 0.0
rodata 120504 120504 0 0.0
text 757524 757524 0 0.0
lighting-app nrf52840dk_nrf52840+rpc (read/write) 1140583 1140583 0 0.0
bss 146240 146240 0 0.0
rodata 115976 115976 0 0.0
text 798012 798012 0 0.0
nrf52840dongle_nrf52840 (read/write) 1075855 1075855 0 0.0
bss 152498 152498 0 0.0
rodata 93520 93520 0 0.0
text 748724 748724 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 1072802 1072802 0 0.0
bss 141686 141686 0 0.0
rodata 116832 116832 0 0.0
text 733208 733208 0 0.0
lock-app nrf52840dk_nrf52840 (read/write) 1129007 1129007 0 0.0
bss 136271 136271 0 0.0
rodata 142400 142400 0 0.0
text 771576 771576 0 0.0
nrf5340dk_nrf5340_cpuapp (read/write) 1032798 1032798 0 0.0
bss 132674 132674 0 0.0
rodata 134876 134876 0 0.0
text 684184 684184 0 0.0
pigweed-app nrf52840dk_nrf52840 (read/write) 571179 571179 0 0.0
bss 74159 74159 0 0.0
rodata 44564 44564 0 0.0
text 393004 393004 0 0.0
pump-app nrf52840dk_nrf52840 (read/write) 1080967 1080967 0 0.0
bss 135170 135170 0 0.0
rodata 117752 117752 0 0.0
text 749108 749108 0 0.0
pump-controller-app nrf52840dk_nrf52840 (read/write) 1067495 1067495 0 0.0
bss 134953 134953 0 0.0
rodata 114232 114232 0 0.0
text 739412 739416 4 0.0
psoc6 all-clusters cy8ckit_062s2_43012 (read only) 881000 881000 0 0.0
(read/write) 1700996 1700996 0 0.0
.ARM.attributes 46 46 0 0.0
.ARM.exidx 8 8 0 0.0
.bss 149688 149688 0 0.0
.comment 204 204 0 0.0
.copy.table 24 24 0 0.0
.cy_m0p_image 6216 6216 0 0.0
.cy_sharedmem 8 8 0 0.0
.data 2656 2656 0 0.0
.debug_abbrev 1217459 1217459 0 0.0
.debug_aranges 111544 111544 0 0.0
.debug_frame 372408 372408 0 0.0
.debug_info 26644545 26644546 1 0.0
.debug_line 3647169 3647169 0 0.0
.debug_loc 3562738 3562738 0 0.0
.debug_ranges 336664 336664 0 0.0
.debug_str 3394161 3394161 0 0.0
.heap 881000 881000 0 0.0
.noinit 148 148 0 0.0
.ramVectors 736 736 0 0.0
.shstrtab 288 288 0 0.0
.stab 156 156 0 0.0
.stabstr 335 335 0 0.0
.stack_dummy 4096 4096 0 0.0
.strtab 569346 569346 0 0.0
.symtab 420416 420416 0 0.0
.text 1540264 1540264 0 0.0
.zero.table 8 8 0 0.0
text 0 0 0 0.0
all-clusters-minimal cy8ckit_062s2_43012 (read only) 881736 881736 0 0.0
(read/write) 1644204 1644204 0 0.0
.ARM.attributes 46 46 0 0.0
.ARM.exidx 8 8 0 0.0
.bss 148952 148952 0 0.0
.comment 204 204 0 0.0
.copy.table 24 24 0 0.0
.cy_m0p_image 6216 6216 0 0.0
.cy_sharedmem 8 8 0 0.0
.data 2656 2656 0 0.0
.debug_abbrev 1209298 1209298 0 0.0
.debug_aranges 111016 111016 0 0.0
.debug_frame 375488 375488 0 0.0
.debug_info 26381241 26381240 -1 -0.0
.debug_line 3667573 3667573 0 0.0
.debug_loc 3550375 3550375 0 0.0
.debug_ranges 335280 335280 0 0.0
.debug_str 3383150 3383150 0 0.0
.heap 881736 881736 0 0.0
.noinit 148 148 0 0.0
.ramVectors 736 736 0 0.0
.shstrtab 288 288 0 0.0
.stab 156 156 0 0.0
.stabstr 335 335 0 0.0
.stack_dummy 4096 4096 0 0.0
.strtab 533820 533820 0 0.0
.symtab 407008 407008 0 0.0
.text 1484208 1484208 0 0.0
.zero.table 0 0 0 0.0
8 8 0 0.0
light cy8ckit_062s2_43012 (read only) 890080 890080 0 0.0
(read/write) 1561436 1561436 0 0.0
.ARM.attributes 46 46 0 0.0
.ARM.exidx 8 8 0 0.0
.bss 140816 140816 0 0.0
.comment 204 204 0 0.0
.copy.table 24 24 0 0.0
.cy_m0p_image 6216 6216 0 0.0
.cy_sharedmem 8 8 0 0.0
.data 2448 2448 0 0.0
.debug_abbrev 1043971 1043971 0 0.0
.debug_aranges 103184 103184 0 0.0
.debug_frame 345732 345732 0 0.0
.debug_info 21845798 21845798 0 0.0
.debug_line 3238757 3238757 0 0.0
.debug_loc 3249995 3249995 0 0.0
.debug_ranges 301120 301120 0 0.0
.debug_str 3189244 3189244 0 0.0
.heap 890080 890080 0 0.0
.noinit 148 148 0 0.0
.ramVectors 736 736 0 0.0
.shstrtab 288 288 0 0.0
.stab 156 156 0 0.0
.stabstr 335 335 0 0.0
.stack_dummy 4096 4096 0 0.0
.strtab 467101 467101 0 0.0
.symtab 374064 374064 0 0.0
.text 1409784 1409784 0 0.0
.zero.table 0 0 0 0.0
8 8 0 0.0
lock cy8ckit_062s2_43012 (read only) 885584 885584 0 0.0
(read/write) 1598724 1598724 0 0.0
.ARM.attributes 46 46 0 0.0
.ARM.exidx 8 8 0 0.0
.bss 145296 145296 0 0.0
.comment 204 204 0 0.0
.copy.table 24 24 0 0.0
.cy_m0p_image 6216 6216 0 0.0
.cy_sharedmem 8 8 0 0.0
.data 2464 2464 0 0.0
.debug_abbrev 1051147 1051147 0 0.0
.debug_aranges 103856 103856 0 0.0
.debug_frame 348556 348556 0 0.0
.debug_info 22200965 22200967 2 0.0
.debug_line 3247439 3247439 0 0.0
.debug_loc 3290071 3290071 0 0.0
.debug_ranges 304536 304536 0 0.0
.debug_str 3216675 3216675 0 0.0
.heap 885584 885584 0 0.0
.noinit 148 148 0 0.0
.ramVectors 736 736 0 0.0
.shstrtab 288 288 0 0.0
.stab 156 156 0 0.0
.stabstr 335 335 0 0.0
.stack_dummy 4096 4096 0 0.0
.strtab 473342 473342 0 0.0
.symtab 377248 377248 0 0.0
.text 1442576 1442576 0 0.0
.zero.table 0 0 0 0.0
8 8 0 0.0
telink light-switch-app tlsr9518adk80d (read/write) 808744 808744 0 0.0
bss 71448 71448 0 0.0
noinit 43488 43488 0 0.0
text 571320 571320 0 0.0
lighting-app tlsr9518adk80d (read/write) 830680 830680 0 0.0
bss 72304 72304 0 0.0
noinit 43488 43488 0 0.0
text 589408 589410 2 0.0

@andy31415
Copy link
Contributor

Postponed past 1.0 for now: this branch had conflicts for a while and the delta is somewhat large.
Generally changing documentation is a judgement call and may be accepted. I am basing my flag based on the line count delta being large.

@andy31415 andy31415 mentioned this pull request Sep 6, 2022
Open
andy31415
andy31415 previously requested changes Sep 7, 2022
View reviewed changes
Copy link
Contributor

@andy31415 andy31415 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Marking changes requested to wait until after 1.0 branch

@andy31415 andy31415 dismissed their stale review September 19, 2022 13:21

1.0 branched

@stale
Copy link

stale bot commented Nov 19, 2022

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the stale Stale issue or PR label Nov 19, 2022
@stale
Copy link

stale bot commented Dec 20, 2022

This stale pull request has been automatically closed. Thank you for your contributions.

@stale stale bot closed this Dec 20, 2022
@gautesl gautesl mentioned this pull request Dec 22, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bzbarsky-apple bzbarsky-apple bzbarsky-apple left review comments

@Damian-Nordic Damian-Nordic Damian-Nordic approved these changes

@greg-fer greg-fer greg-fer approved these changes

@andy31415 andy31415 andy31415 left review comments

@anush-apple anush-apple Awaiting requested review from anush-apple

@arkq arkq Awaiting requested review from arkq

@Byungjoo-Lee Byungjoo-Lee Awaiting requested review from Byungjoo-Lee

@carol-apple carol-apple Awaiting requested review from carol-apple

@chrisdecenzo chrisdecenzo Awaiting requested review from chrisdecenzo

@chshu chshu Awaiting requested review from chshu

@chulspro chulspro Awaiting requested review from chulspro

@dhrishi dhrishi Awaiting requested review from dhrishi

@electrocucaracha electrocucaracha Awaiting requested review from electrocucaracha

@emargolis emargolis Awaiting requested review from emargolis

@franck-apple franck-apple Awaiting requested review from franck-apple

@gjc13 gjc13 Awaiting requested review from gjc13

@harimau-qirex harimau-qirex Awaiting requested review from harimau-qirex

@harsha-rajendran harsha-rajendran Awaiting requested review from harsha-rajendran

@hawk248 hawk248 Awaiting requested review from hawk248

@isiu-apple isiu-apple Awaiting requested review from isiu-apple

@jelderton jelderton Awaiting requested review from jelderton

@jepenven-silabs jepenven-silabs Awaiting requested review from jepenven-silabs

@jmartinez-silabs jmartinez-silabs Awaiting requested review from jmartinez-silabs

@jtung-apple jtung-apple Awaiting requested review from jtung-apple

@kghost kghost Awaiting requested review from kghost

@kpschoedel kpschoedel Awaiting requested review from kpschoedel

@lazarkov lazarkov Awaiting requested review from lazarkov

@LuDuda LuDuda Awaiting requested review from LuDuda

@mrjerryjohns mrjerryjohns Awaiting requested review from mrjerryjohns

@msandstedt msandstedt Awaiting requested review from msandstedt

@mspang mspang Awaiting requested review from mspang

@rgoliver rgoliver Awaiting requested review from rgoliver

@robszewczyk robszewczyk Awaiting requested review from robszewczyk

@sagar-apple sagar-apple Awaiting requested review from sagar-apple

@saurabhst saurabhst Awaiting requested review from saurabhst

@selissia selissia Awaiting requested review from selissia

@tcarmelveilleux tcarmelveilleux Awaiting requested review from tcarmelveilleux

@tecimovic tecimovic Awaiting requested review from tecimovic

@tehampson tehampson Awaiting requested review from tehampson

@vijs vijs Awaiting requested review from vijs

@vivien-apple vivien-apple Awaiting requested review from vivien-apple

@wbschiller wbschiller Awaiting requested review from wbschiller

@woody-apple woody-apple Awaiting requested review from woody-apple

@xylophone21 xylophone21 Awaiting requested review from xylophone21

Assignees
No one assigned
Labels
darwin documentation Improvements or additions to documentation examples github platform review - pending stale Stale issue or PR tools workflows
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@gautesl @CLAassistant @LuDuda @andy31415 @greg-fer @bzbarsky-apple @Damian-Nordic