Fix broken doc links and resolve dependency conflicts #37694
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Review changes with |
|
|
github-actions
bot
added
the
documentation
|
PR #37694: Size comparison from 5398152 to c386a2a Full report (73 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
HaSH147
force-pushed
the
solve_doc_links
branch
from
ba446df to
48a61c7
Compare
|
PR #37694: Size comparison from 06edeee to e2db95f Full report (52 builds for bl602, bl702, bl702l, cc13x4_26x4, efr32, esp32, linux, nrfconnect, nxp, qpg, stm32, telink, tizen)
|
|
PR #37694: Size comparison from 06edeee to 9c14237 Full report (52 builds for bl602, bl702, bl702l, cc13x4_26x4, efr32, esp32, linux, nrfconnect, nxp, qpg, stm32, telink, tizen)
|
|
Hi @andy31415, can you please review this PR ? |
andy31415
reviewed
Feb 21, 2025
| @@ -18,7 +18,9 @@ Follow | |||
| [these](https://github.com/project-chip/connectedhomeip/edit/master/docs/VSCODE_DEVELOPMENT.md) | |||
| steps to set up Visual Studio Code for Matter development. | |||
|
|
|||
| ### Linux <a name="linux"> | |||
| (linux)= | |||
There was a problem hiding this comment.
this seems off ... what is (linux)=? i tried to view the "rich diff" and it does indeed that this shows up verbatim and if so, it looks odd.
yunhanw-google
approved these changes
Feb 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goals
This PR fixes broken documentation links and resolves dependency conflicts within the Matter SDK documentation. Specifically, it addresses the following issues:
Fixes Docutils update fails to compile our documentation #37632 by updating these dependencies to eliminate conflicts : Sphinx to 8.2.0 and myst-parser to >=2.0.0 and pydata-sphinx-theme as mentioned in this dependabot PR Bump pydata-sphinx-theme from 0.14.4 to 0.16.1 #37594
On the HTML page: Project CHIP Docs, clicking on chip-tool or chip-repl from the right side (not the sidebar) redirected users to an invalid link.
.ipynb files were not properly linked in the Sphinx-generated documentation, causing them to redirect to a "not found" page.
Testing
Manually verified the corrected links by running make html and checking the generated _build/html/development_controllers/index.html.
Checked .ipynb links on GitHub to ensure they properly resolve to the expected files.