Skip to content

Enable github/workflow to verify Dockerfile. #5035

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 1 commit into from
Feb 16, 2025

Conversation

fujitatomoya
Copy link
Collaborator

follow-up of #5021

Copy link

github-actions bot commented Feb 15, 2025

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/13348160833/artifacts/2597631924.

To view the resulting site:

  1. Click on the above link to download the artifacts archive
  2. Extract it
  3. Open html-artifacts-5035/index.html in your favorite browser

@fujitatomoya fujitatomoya force-pushed the fujitatomoya/enable-workflow-dockerfile branch from 1415b24 to d913359 Compare February 15, 2025 19:33
@fujitatomoya fujitatomoya force-pushed the fujitatomoya/enable-workflow-dockerfile branch from d913359 to 997c8a7 Compare February 15, 2025 19:47
@fujitatomoya fujitatomoya force-pushed the fujitatomoya/enable-workflow-dockerfile branch from 997c8a7 to 7d0cdd9 Compare February 15, 2025 19:53
@fujitatomoya
Copy link
Collaborator Author

@christophebedard could you take a look when you have time?

@fujitatomoya
Copy link
Collaborator Author

@christophebedard thanks!

@kscottz @Crola1702 just a note, after this PR is merged new github workflow is online. that workflow is only for https://github.com/ros2/ros2_documentation/blob/rolling/docker/image/Dockerfile that is used to generate the documentation with CI. this new github workflow makes sure generating documentation with docker build to work okay, so that we can detect this kind of CI doc regression before merge. besides, this new workflow is activated only when Dockerfile is updated, that means usually nobody gets bothered by this workflow during contribution unless they change something in Dockerfile.

@fujitatomoya fujitatomoya self-assigned this Feb 16, 2025
@fujitatomoya fujitatomoya added the backport-all backport at reviewers discretion; from rolling to all versions label Feb 16, 2025
@fujitatomoya fujitatomoya merged commit 175e677 into rolling Feb 16, 2025
6 checks passed
@fujitatomoya fujitatomoya deleted the fujitatomoya/enable-workflow-dockerfile branch February 16, 2025 00:25
mergify bot pushed a commit that referenced this pull request Feb 16, 2025
Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit 175e677)
mergify bot pushed a commit that referenced this pull request Feb 16, 2025
Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit 175e677)
fujitatomoya added a commit that referenced this pull request Feb 16, 2025
Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit 175e677)

Co-authored-by: Tomoya Fujita <[email protected]>
fujitatomoya added a commit that referenced this pull request Feb 16, 2025
Signed-off-by: Tomoya Fujita <[email protected]>
(cherry picked from commit 175e677)

Co-authored-by: Tomoya Fujita <[email protected]>
DLu pushed a commit to DLu/ros2_documentation that referenced this pull request Feb 18, 2025
fujitatomoya added a commit that referenced this pull request Mar 13, 2025
* Sentence Checker

* Some edits

* Update About-Executors.rst

* More sentence breaks

* More cleanup

* More sentences

* Fix smart quotes

* fix group tag indent for ROSCon 2023 and 2024 contents. (#5016)

Signed-off-by: Tomoya Fujita <[email protected]>

* Clean up sentences II (white space changes only) (#5017)

* Exclude literals parts from bold parts in 'Ament Lint CLI Utilities' (#5024)

You can't do nested inline markup in RST:

**Can't do ``this`` in RST.**

The simplest solution is to just exclude the ``literal`` part.

Also, do some other minor fixes.

Signed-off-by: Christophe Bedard <[email protected]>

* remove --break-system-packages and address docker build warnings. (#5021)

* remove --break-system-packages and address docker build warnings.

Signed-off-by: Tomoya Fujita <[email protected]>

* add github workflow to test Dockerfile.

Signed-off-by: Tomoya Fujita <[email protected]>

* Revert "add github workflow to test Dockerfile."

This reverts commit 8686f18.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>

* More

* Other sentence formatting (#5031)

* Add second dot to abbreviations
* Remove some random periods
* Escape some periods
* Convert some links
* Add formatted block

* Enable github/workflow to verify Dockerfile. (#5035)

Signed-off-by: Tomoya Fujita <[email protected]>

* Update Using-Node-Interfaces-Template-Class.rst (#5038)

Added missing ``Output:`` before the terminal output for consistency reasons

Signed-off-by: Nikos Tziaros <[email protected]>

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediat… (#5034)

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediate.rst

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate.rst

Thanks for pointing it out, I didnt notice the extention beeing there

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

---------

Signed-off-by: Nikos Tziaros <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>

* more bits

* Some rollbacks

* Ignore

* Use sphinx_tamer

* More Sphinx Config

* Updated checker using subprocess

* Make sphinx-lint-with-ros exit with non-zero error codes

Signed-off-by: Shane Loretz <[email protected]>

* Wrap r2d2.rviz in backticks

Signed-off-by: Shane Loretz <[email protected]>

* Wrap URL in RST link

Signed-off-by: Shane Loretz <[email protected]>

* Add empty line after section title

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Add empty line after section title

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Use normalized project name sphinx-tamer

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Make sentence checker ignore `.idl`

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
Signed-off-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Co-authored-by: Nikos Tziaros <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Co-authored-by: Shane Loretz <[email protected]>
Co-authored-by: Shane Loretz <[email protected]>
mergify bot pushed a commit that referenced this pull request Mar 13, 2025
* Sentence Checker

* Some edits

* Update About-Executors.rst

* More sentence breaks

* More cleanup

* More sentences

* Fix smart quotes

* fix group tag indent for ROSCon 2023 and 2024 contents. (#5016)

Signed-off-by: Tomoya Fujita <[email protected]>

* Clean up sentences II (white space changes only) (#5017)

* Exclude literals parts from bold parts in 'Ament Lint CLI Utilities' (#5024)

You can't do nested inline markup in RST:

**Can't do ``this`` in RST.**

The simplest solution is to just exclude the ``literal`` part.

Also, do some other minor fixes.

Signed-off-by: Christophe Bedard <[email protected]>

* remove --break-system-packages and address docker build warnings. (#5021)

* remove --break-system-packages and address docker build warnings.

Signed-off-by: Tomoya Fujita <[email protected]>

* add github workflow to test Dockerfile.

Signed-off-by: Tomoya Fujita <[email protected]>

* Revert "add github workflow to test Dockerfile."

This reverts commit 8686f18.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>

* More

* Other sentence formatting (#5031)

* Add second dot to abbreviations
* Remove some random periods
* Escape some periods
* Convert some links
* Add formatted block

* Enable github/workflow to verify Dockerfile. (#5035)

Signed-off-by: Tomoya Fujita <[email protected]>

* Update Using-Node-Interfaces-Template-Class.rst (#5038)

Added missing ``Output:`` before the terminal output for consistency reasons

Signed-off-by: Nikos Tziaros <[email protected]>

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediat… (#5034)

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediate.rst

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate.rst

Thanks for pointing it out, I didnt notice the extention beeing there

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

---------

Signed-off-by: Nikos Tziaros <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>

* more bits

* Some rollbacks

* Ignore

* Use sphinx_tamer

* More Sphinx Config

* Updated checker using subprocess

* Make sphinx-lint-with-ros exit with non-zero error codes

Signed-off-by: Shane Loretz <[email protected]>

* Wrap r2d2.rviz in backticks

Signed-off-by: Shane Loretz <[email protected]>

* Wrap URL in RST link

Signed-off-by: Shane Loretz <[email protected]>

* Add empty line after section title

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Add empty line after section title

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Use normalized project name sphinx-tamer

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Make sentence checker ignore `.idl`

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
Signed-off-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Co-authored-by: Nikos Tziaros <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Co-authored-by: Shane Loretz <[email protected]>
Co-authored-by: Shane Loretz <[email protected]>
(cherry picked from commit 784fd45)

# Conflicts:
#	source/Installation/Alternatives/Windows-Development-Setup.rst
mergify bot pushed a commit that referenced this pull request Mar 13, 2025
* Sentence Checker

* Some edits

* Update About-Executors.rst

* More sentence breaks

* More cleanup

* More sentences

* Fix smart quotes

* fix group tag indent for ROSCon 2023 and 2024 contents. (#5016)

Signed-off-by: Tomoya Fujita <[email protected]>

* Clean up sentences II (white space changes only) (#5017)

* Exclude literals parts from bold parts in 'Ament Lint CLI Utilities' (#5024)

You can't do nested inline markup in RST:

**Can't do ``this`` in RST.**

The simplest solution is to just exclude the ``literal`` part.

Also, do some other minor fixes.

Signed-off-by: Christophe Bedard <[email protected]>

* remove --break-system-packages and address docker build warnings. (#5021)

* remove --break-system-packages and address docker build warnings.

Signed-off-by: Tomoya Fujita <[email protected]>

* add github workflow to test Dockerfile.

Signed-off-by: Tomoya Fujita <[email protected]>

* Revert "add github workflow to test Dockerfile."

This reverts commit 8686f18.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>

* More

* Other sentence formatting (#5031)

* Add second dot to abbreviations
* Remove some random periods
* Escape some periods
* Convert some links
* Add formatted block

* Enable github/workflow to verify Dockerfile. (#5035)

Signed-off-by: Tomoya Fujita <[email protected]>

* Update Using-Node-Interfaces-Template-Class.rst (#5038)

Added missing ``Output:`` before the terminal output for consistency reasons

Signed-off-by: Nikos Tziaros <[email protected]>

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediat… (#5034)

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediate.rst

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate.rst

Thanks for pointing it out, I didnt notice the extention beeing there

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

---------

Signed-off-by: Nikos Tziaros <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>

* more bits

* Some rollbacks

* Ignore

* Use sphinx_tamer

* More Sphinx Config

* Updated checker using subprocess

* Make sphinx-lint-with-ros exit with non-zero error codes

Signed-off-by: Shane Loretz <[email protected]>

* Wrap r2d2.rviz in backticks

Signed-off-by: Shane Loretz <[email protected]>

* Wrap URL in RST link

Signed-off-by: Shane Loretz <[email protected]>

* Add empty line after section title

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Add empty line after section title

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Use normalized project name sphinx-tamer

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Make sentence checker ignore `.idl`

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
Signed-off-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Co-authored-by: Nikos Tziaros <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Co-authored-by: Shane Loretz <[email protected]>
Co-authored-by: Shane Loretz <[email protected]>
(cherry picked from commit 784fd45)

# Conflicts:
#	source/Installation/Alternatives/RHEL-Development-Setup.rst
#	source/Installation/Alternatives/Windows-Development-Setup.rst
#	source/Installation/_rosdep_Linux_Mint.rst
fujitatomoya added a commit that referenced this pull request Mar 14, 2025
* Sentence checker (#4592)

* Sentence Checker

* Some edits

* Update About-Executors.rst

* More sentence breaks

* More cleanup

* More sentences

* Fix smart quotes

* fix group tag indent for ROSCon 2023 and 2024 contents. (#5016)

Signed-off-by: Tomoya Fujita <[email protected]>

* Clean up sentences II (white space changes only) (#5017)

* Exclude literals parts from bold parts in 'Ament Lint CLI Utilities' (#5024)

You can't do nested inline markup in RST:

**Can't do ``this`` in RST.**

The simplest solution is to just exclude the ``literal`` part.

Also, do some other minor fixes.

Signed-off-by: Christophe Bedard <[email protected]>

* remove --break-system-packages and address docker build warnings. (#5021)

* remove --break-system-packages and address docker build warnings.

Signed-off-by: Tomoya Fujita <[email protected]>

* add github workflow to test Dockerfile.

Signed-off-by: Tomoya Fujita <[email protected]>

* Revert "add github workflow to test Dockerfile."

This reverts commit 8686f18.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>

* More

* Other sentence formatting (#5031)

* Add second dot to abbreviations
* Remove some random periods
* Escape some periods
* Convert some links
* Add formatted block

* Enable github/workflow to verify Dockerfile. (#5035)

Signed-off-by: Tomoya Fujita <[email protected]>

* Update Using-Node-Interfaces-Template-Class.rst (#5038)

Added missing ``Output:`` before the terminal output for consistency reasons

Signed-off-by: Nikos Tziaros <[email protected]>

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediat… (#5034)

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediate.rst

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate.rst

Thanks for pointing it out, I didnt notice the extention beeing there

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

---------

Signed-off-by: Nikos Tziaros <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>

* more bits

* Some rollbacks

* Ignore

* Use sphinx_tamer

* More Sphinx Config

* Updated checker using subprocess

* Make sphinx-lint-with-ros exit with non-zero error codes

Signed-off-by: Shane Loretz <[email protected]>

* Wrap r2d2.rviz in backticks

Signed-off-by: Shane Loretz <[email protected]>

* Wrap URL in RST link

Signed-off-by: Shane Loretz <[email protected]>

* Add empty line after section title

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Add empty line after section title

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Use normalized project name sphinx-tamer

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Make sentence checker ignore `.idl`

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
Signed-off-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Co-authored-by: Nikos Tziaros <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Co-authored-by: Shane Loretz <[email protected]>
Co-authored-by: Shane Loretz <[email protected]>
(cherry picked from commit 784fd45)

# Conflicts:
#	source/Installation/Alternatives/Windows-Development-Setup.rst

* resolve conflict.

Signed-off-by: Tomoya Fujita <[email protected]>

* make linter happy.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
Co-authored-by: David V. Lu!! <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
christophebedard pushed a commit that referenced this pull request Mar 14, 2025
* Sentence checker (#4592)

* Sentence Checker

* Some edits

* Update About-Executors.rst

* More sentence breaks

* More cleanup

* More sentences

* Fix smart quotes

* fix group tag indent for ROSCon 2023 and 2024 contents. (#5016)

Signed-off-by: Tomoya Fujita <[email protected]>

* Clean up sentences II (white space changes only) (#5017)

* Exclude literals parts from bold parts in 'Ament Lint CLI Utilities' (#5024)

You can't do nested inline markup in RST:

**Can't do ``this`` in RST.**

The simplest solution is to just exclude the ``literal`` part.

Also, do some other minor fixes.

Signed-off-by: Christophe Bedard <[email protected]>

* remove --break-system-packages and address docker build warnings. (#5021)

* remove --break-system-packages and address docker build warnings.

Signed-off-by: Tomoya Fujita <[email protected]>

* add github workflow to test Dockerfile.

Signed-off-by: Tomoya Fujita <[email protected]>

* Revert "add github workflow to test Dockerfile."

This reverts commit 8686f18.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>

* More

* Other sentence formatting (#5031)

* Add second dot to abbreviations
* Remove some random periods
* Escape some periods
* Convert some links
* Add formatted block

* Enable github/workflow to verify Dockerfile. (#5035)

Signed-off-by: Tomoya Fujita <[email protected]>

* Update Using-Node-Interfaces-Template-Class.rst (#5038)

Added missing ``Output:`` before the terminal output for consistency reasons

Signed-off-by: Nikos Tziaros <[email protected]>

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediat… (#5034)

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediate.rst

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate.rst

Thanks for pointing it out, I didnt notice the extention beeing there

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>

---------

Signed-off-by: Nikos Tziaros <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>

* more bits

* Some rollbacks

* Ignore

* Use sphinx_tamer

* More Sphinx Config

* Updated checker using subprocess

* Make sphinx-lint-with-ros exit with non-zero error codes

Signed-off-by: Shane Loretz <[email protected]>

* Wrap r2d2.rviz in backticks

Signed-off-by: Shane Loretz <[email protected]>

* Wrap URL in RST link

Signed-off-by: Shane Loretz <[email protected]>

* Add empty line after section title

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Add empty line after section title

Co-authored-by: Christophe Bedard <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Use normalized project name sphinx-tamer

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

* Make sentence checker ignore `.idl`

Co-authored-by: Tomoya Fujita <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
Signed-off-by: Christophe Bedard <[email protected]>
Signed-off-by: Nikos Tziaros <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>
Signed-off-by: Shane Loretz <[email protected]>
Co-authored-by: Tomoya Fujita <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Co-authored-by: Nikos Tziaros <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Christophe Bedard <[email protected]>
Co-authored-by: Shane Loretz <[email protected]>
Co-authored-by: Shane Loretz <[email protected]>
(cherry picked from commit 784fd45)

# Conflicts:
#	source/Installation/Alternatives/RHEL-Development-Setup.rst
#	source/Installation/Alternatives/Windows-Development-Setup.rst
#	source/Installation/_rosdep_Linux_Mint.rst

* resolve conflicts.

Signed-off-by: Tomoya Fujita <[email protected]>

* make linter happy.

Signed-off-by: Tomoya Fujita <[email protected]>

* address review comments.

Signed-off-by: Tomoya Fujita <[email protected]>

---------

Signed-off-by: Tomoya Fujita <[email protected]>
Co-authored-by: David V. Lu!! <[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
Labels
backport-all backport at reviewers discretion; from rolling to all versions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants