fix linking WARNING: unknown document. #5343
Merged
Conversation
This file contains hidden or 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
Signed-off-by: Tomoya Fujita <[email protected]>
fujitatomoya
commented
Apr 24, 2025
| @@ -8,7 +8,7 @@ ifeq ($(OS),Windows_NT) | |||
| PYTHON := python | |||
| endif | |||
| BUILD = $(PYTHON) -m sphinx | |||
| OPTS =-c . | |||
| OPTS =-c . -W # Treat warnings as errors | |||
There was a problem hiding this comment.
this allows github action to detect the following.
rosindex@91da263e01b7:/tmp/doc_repository$ make html
Running Sphinx v7.2.6
loading pickled environment... done
...
/tmp/doc_repository/source/Concepts/Intermediate/About-Different-Middleware-Vendors.rst:67: WARNING: unknown document: '../../Installation/DDS-Implementations'
/tmp/doc_repository/source/How-To-Guides/Working-with-multiple-RMW-implementations.rst:24: WARNING: unknown document: '../Installation/DDS-Implementations'
/tmp/doc_repository/source/How-To-Guides/Working-with-multiple-RMW-implementations.rst:69: WARNING: unknown document: '../Installation/DDS-Implementations'
/tmp/doc_repository/source/Tutorials/Advanced/Security/Introducing-ros2-security.rst:80: WARNING: unknown document: '../../../Installation/DDS-Implementations/'
...these warnings were detected, but github action does not fail with these warnings. see https://github.com/ros2/ros2_documentation/actions/runs/14647996323/job/41106929709
with this -W option, now it can detect via github action.
Warning, treated as error:
/tmp/doc_repository/source/Concepts/Intermediate/About-Different-Middleware-Vendors.rst:67:unknown document: '../../Installation/DDS-Implementations'
make: *** [Makefile:23: html] Error 2
|
@christophebedard @ahcorde what do you think enforcing warning as error option? |
christophebedard
approved these changes
Apr 24, 2025
|
HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/14651670476/artifacts/3005458746. To view the resulting site:
|
ahcorde
approved these changes
Apr 24, 2025
ahcorde
added
the
backport-all
mergify bot
pushed a commit
that referenced
this pull request
Apr 24, 2025
Signed-off-by: Tomoya Fujita <[email protected]> (cherry picked from commit 94adc5e)
mergify bot
pushed a commit
that referenced
this pull request
Apr 24, 2025
Signed-off-by: Tomoya Fujita <[email protected]> (cherry picked from commit 94adc5e)
This was referenced Apr 24, 2025
fujitatomoya
added a commit
that referenced
this pull request
Apr 24, 2025
Signed-off-by: Tomoya Fujita <[email protected]> (cherry picked from commit 94adc5e)
fujitatomoya
added a commit
that referenced
this pull request
Apr 24, 2025
Signed-off-by: Tomoya Fujita <[email protected]> (cherry picked from commit 94adc5e)
fujitatomoya
added a commit
that referenced
this pull request
Apr 24, 2025
Signed-off-by: Tomoya Fujita <[email protected]> (cherry picked from commit 94adc5e) Co-authored-by: Tomoya Fujita <[email protected]>
fujitatomoya
added a commit
that referenced
this pull request
Apr 24, 2025
* fix linking WARNING: unknown document. (#5343) Signed-off-by: Tomoya Fujita <[email protected]> (cherry picked from commit 94adc5e) * more internal link fixes to RMW-Implementations section. Signed-off-by: Tomoya Fujita <[email protected]> --------- Signed-off-by: Tomoya Fujita <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]>
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.
address warnings are generated by #5231.