Skip to content

fix(docs): Fix links and versions #11505

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.

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

Merged
merged 2 commits into from
Jun 24, 2025
Merged

Conversation

lucasssvaz
Copy link
Collaborator

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:

  • Added rst_prolog in docs/conf_common.py to enable variable substitution for |version| and |idf_version| throughout the documentation. This allows dynamic updates of version information.
  • Included the sphinx_substitution_extensions extension in docs/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:

  • Replaced hardcoded version references with |version| in docs/en/esp-idf_component.rst for better maintainability. This affects notes and example commands.
  • Fixed broken internal documentation links to use .html extensions.
  • Added a note in docs/en/index.rst specifying that the documentation is valid for the current |version| and |idf_version|.

Contributor Guidance Enhancements:

  • Clarified the need for virtual environments when installing dependencies in docs/en/guides/docs_contributing.rst.
  • Improved guidance on Visual Studio Code extensions by consolidating recommendations and adding a link to the reStructuredText Pack.

Dependency Updates:

  • Updated docs/requirements.txt to include missing sphinx==4.5.0 and Sphinx-Substitution-Extensions==2022.2.16 to support the new substitution functionality.

Tests scenarios

Tested locally

Related links

Closes #11484

@lucasssvaz lucasssvaz added this to the 3.2.1 milestone Jun 23, 2025
@lucasssvaz lucasssvaz self-assigned this Jun 23, 2025
@lucasssvaz lucasssvaz requested a review from pedrominatel as a code owner June 23, 2025 15:19
@lucasssvaz lucasssvaz added the Type: Documentation Issue pertains to Documentation of Arduino ESP32 label Jun 23, 2025
Copy link
Contributor

github-actions bot commented Jun 23, 2025

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello lucasssvaz, we appreciate your contribution to this project!


📘 Please review the project's Contributions Guide for key guidelines on code, documentation, testing, and more.

🖊️ Please also make sure you have read and signed the Contributor License Agreement for this project.

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against 53d9d42

@lucasssvaz lucasssvaz moved this from Todo to In Review in Arduino ESP32 Core Project Roadmap Jun 23, 2025
Copy link
Member

@pedrominatel pedrominatel left a comment

Choose a reason for hiding this comment

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

Thank you @lucasssvaz for this improvement!!
I've only one small suggestion, otherwise, LGTM.

@lucasssvaz lucasssvaz added the Status: Pending Merge Pull Request is ready to be merged label Jun 24, 2025
@me-no-dev me-no-dev merged commit 30fb3cb into espressif:master Jun 24, 2025
12 checks passed
@lucasssvaz lucasssvaz deleted the fix/docs_links branch June 24, 2025 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Pending Merge Pull Request is ready to be merged Type: Documentation Issue pertains to Documentation of Arduino ESP32
Projects
Development

Successfully merging this pull request may close these issues.

Wrong ESP-IDF version in documentation
3 participants