mirror of
https://github.com/espressif/esp-matter.git
synced 2026-04-28 03:23:07 +00:00
Shubham Patil
5cb96e8b3d
- Ran linkcheck on the built docs and fixed broken links - Added exceptions for private, anchors, and server errors that may come up when we run the linkcheck in CI. - Also ignore self-referential GitHub links with commit hashes - Fixed links on the insights page - Converted some links to use the anchored format - Fixes #1319
Documentation Source Folder
This folder contains source files for the documentation of Espressif's SDK for Matter.
The sources do not render well in GitHub and some information is not visible at all.
Use actual documentation generated within about 20 minutes on each commit:
Hosted Documentation
The above URL is for the main branch latest version. Click the drop-down in the bottom left to choose a particular version or to download a PDF.
Building Documentation
The documentation is built using the python package esp-docs, which can be installed by running pip install esp-docs. Running build-docs --help will give a summary of available options. For more information see the esp-docs documentation at https://github.com/espressif/esp-docs/blob/master/README.md