fix(docs): Fix links and versions #11505
Merged
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.
Description of Change
This pull request introduces several updates to the documentation system, focusing on adding variable substitution support, improving documentation processes, and updating dependency requirements. The most significant changes include enabling dynamic version substitution in documentation, updating links for better compatibility, and enhancing contributor guidance.
Enhancements to Documentation System:
rst_prolog
indocs/conf_common.py
to enable variable substitution for|version|
and|idf_version|
throughout the documentation. This allows dynamic updates of version information.sphinx_substitution_extensions
extension indocs/conf_common.py
to support the new substitution functionality. This extension allows for more flexibility when compared to the default Sphinx substitution (for example substitutions inside code blocks).Improvements to Documentation Content:
|version|
indocs/en/esp-idf_component.rst
for better maintainability. This affects notes and example commands..html
extensions.docs/en/index.rst
specifying that the documentation is valid for the current|version|
and|idf_version|
.Contributor Guidance Enhancements:
docs/en/guides/docs_contributing.rst
.reStructuredText Pack
.Dependency Updates:
docs/requirements.txt
to include missingsphinx==4.5.0
andSphinx-Substitution-Extensions==2022.2.16
to support the new substitution functionality.Tests scenarios
Tested locally
Related links
Closes #11484