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

Update doc version warning logic to exclude specific pages #4180

Open
wants to merge 1 commit into
base: rolling
Choose a base branch
from
Open

Update doc version warning logic to exclude specific pages #4180

wants to merge 1 commit into from

Commits on Feb 21, 2024

  1. Update doc version warning logic to exclude specific pages 

    This commit modifies the Sphinx template logic to prevent the version warning message from appearing on the 'Contributing to ROS 2 Documentation' page and any pages within the 'Releases' section. The update is aimed at improving user experience by selectively displaying version warnings only where relevant.

Additionally, this change addresses and resolves issues ros2#3949 and ros2#3966, which were related to unwanted version warning messages on documentation pages deemed unnecessary for such alerts.

- Exclude '/Contributing/Contributing-To-ROS-2-Documentation.html' from version warning messages.
- Exclude any pages under '/Releases/' from version warning messages.
- Fixes ros2#3949 and ros2#3966.


Signed-off-by: Victor Boyd <[email protected]>
    @Victor-Boyd
    Victor-Boyd authored Feb 21, 2024
    Configuration menu
    Copy the full SHA
    2930a4f View commit details
    Browse the repository at this point in the history