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.

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

Update Writing-A-Simple-Cpp-Service-And-Client.rst #3980

Closed
wants to merge 132 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
132 commits
Select commit Hold shift + click to select a range
906150c
Merge the Fedora build instructions into the RHEL ones. (#3487) (#3488)
mergify[bot] Apr 28, 2023
1f04d79
Switch to ros2-testing for Iron pre-release testing (#3486)
Yadunund May 2, 2023
a106e0b
Tell users to 'apt update' before installing ros-dev-tools. (#3491) (…
mergify[bot] May 3, 2023
cf1a64b
Add in Iron logo. (#3494) (#3496)
mergify[bot] May 3, 2023
ec18bd4
Add iceoryx_binding_c and rmw_connextdds to binary skip-keys. (#3493)…
mergify[bot] May 3, 2023
67667d9
Update the link to the ros1_bridge. (#3501) (#3502)
mergify[bot] May 3, 2023
e461b54
Update the Iron complete changelog. (#3495) (#3507)
mergify[bot] May 4, 2023
052c7b4
Update the language in development setup for skipping packages. (#350…
mergify[bot] May 4, 2023
725ceaf
A few Windows install instruction fixups (#3511)
mjcarroll May 4, 2023
99a3508
Reword data that is accumulated (#3504) (#3512)
mergify[bot] May 4, 2023
5d40bbb
Cleanup Recording-A-Bag-From-Your-Own-Node. (#3518) (#3520)
mergify[bot] May 4, 2023
6d2dba7
Fix wildcard search for launch files in tf2 tutorial (#3506) (#3523)
mergify[bot] May 4, 2023
a1eab75
Update Recording-A-Bag-From-Your-Own-Node-CPP.rst (#3536)
clalancette May 6, 2023
c292d0c
Doc update (#3532) (#3539)
mergify[bot] May 6, 2023
dc22858
Update the Creating a package explanation. (#3540) (#3545)
mergify[bot] May 8, 2023
591660b
Update the package contents. (#3541) (#3548)
mergify[bot] May 8, 2023
6f32624
Update tf2_echo output. (#3538) (#3551)
mergify[bot] May 8, 2023
d693a61
Update Pluginlib.rst (#3544) (#3552)
mergify[bot] May 8, 2023
46c44cc
Add in a link to the composition demo launch file. (#3553) (#3554)
mergify[bot] May 8, 2023
f96d234
Update Debugging-Tf2-Problems.rst (#3557) (#3559)
mergify[bot] May 8, 2023
46fdf7a
ros2pkg generates license warning messages. (#3535) (#3560)
mergify[bot] May 9, 2023
35978d2
Inform users to install zlib when following windows binaries guide (#…
mergify[bot] May 9, 2023
9419262
Add Nav2 slack to WG (#3566) (#3567)
mergify[bot] May 9, 2023
545f438
Fix using-python-packages note issue (#3565) (#3570)
mergify[bot] May 9, 2023
9203689
Get rid of a bogus explanation of the subscriber member variable. (#3…
mergify[bot] May 9, 2023
0db0f97
Replace boolean gender field in interface tutorial (#3533) (#3558) (#…
mergify[bot] May 9, 2023
cdeaa39
use --cmake-clean-cache instead of --cmake-force-configure (#3562) (#…
mergify[bot] May 9, 2023
6537cec
Switch the name of the custom action interface package. (#3561) (#3588)
mergify[bot] May 11, 2023
9920b39
Update after testing for Tf2 "Using Time (C++)" and "Time travel (C++…
mergify[bot] May 11, 2023
875c805
Switch from 'docker-compose' to 'docker compose'. (#3527) (#3590)
mergify[bot] May 11, 2023
3c39a6a
Update to "Travel in time (Python)" after testing (#3582) (#3592)
mergify[bot] May 12, 2023
ecb46b2
Update security Dockerfile to iron distro (#3581)
jmackay2 May 12, 2023
ea70b24
a period missed (#3595) (#3597)
mergify[bot] May 15, 2023
c115a24
Update rosbag2 section in Iron release notes (#3593) (#3598)
mergify[bot] May 15, 2023
3bb548e
Update About-Executors.rst (#3594) (#3602)
mergify[bot] May 15, 2023
1970335
Clarify and add some examples to Callback groups docs (#3584) (#3605)
mergify[bot] May 15, 2023
6a0da91
Updates to the Real-Time programming tutorial. (#3604) (#3608)
mergify[bot] May 15, 2023
4133f0e
Update Release-Iron-Irwini.rst (#3609)
kscottz May 16, 2023
0c013b4
Remove 'Using Turtlebot 2' link on Demos page (#3620) (#3622)
mergify[bot] May 17, 2023
714e21d
Update 'Motion planning for a MoveIt 2 arm' link on Demos page (#3619…
mergify[bot] May 17, 2023
804218e
Document ROS Iron discovery options (#3519) (#3628)
mergify[bot] May 17, 2023
5a6d5df
Fix keystore dir name (#3634) (#3635)
mergify[bot] May 18, 2023
367ce30
Fix the ros_tutorials branch. (#3631) (#3636)
mergify[bot] May 18, 2023
a83fac8
Add composition paper (#3638) (#3639)
mergify[bot] May 18, 2023
b190501
Change representative of Bosch to Christian Henkel (#3642) (#3644)
mergify[bot] May 19, 2023
831a5b4
update doc for the building ros2 package with eclipse (#3643) (#3648)
mergify[bot] May 20, 2023
089feac
Final update to the Iron complete changelog. (#3647) (#3653)
mergify[bot] May 22, 2023
21e6d9a
Adding more Webots Simulation Tutorials (#3357) (#3656)
mergify[bot] May 22, 2023
ae3d6dd
Revert "Switch to ros2-testing for Iron pre-release testing" (#3611)
Yadunund May 23, 2023
ade8981
Add EventsExecutor release notes (#3662) (#3665)
mergify[bot] May 23, 2023
f12e261
Add Known Issues for Iron at release (#3659) (#3668)
mergify[bot] May 23, 2023
33b1752
Release Iron Irwini (#3610) (#3671)
mergify[bot] May 23, 2023
af39b29
split build processes to save execution time in ghactions (#3661) (#3…
mergify[bot] May 23, 2023
1806365
Mention not needing to source workspace before running tests (#3677) …
mergify[bot] May 24, 2023
734096b
use jammy instead of focal for iron (#3684) (#3685)
mergify[bot] May 25, 2023
0b93f15
fix a typo in Executors documentation (#3689) (#3690)
mergify[bot] May 28, 2023
baa17b9
fix link to rclpy api docs in About-ROS-2-Client-Libraries.rst (#3693…
mergify[bot] May 30, 2023
f84171a
Add keyboard markup (#3695) (#3696)
mergify[bot] May 30, 2023
0f5ddd6
to fix warning and use jammy (#3679) (#3704)
mergify[bot] Jun 5, 2023
d84b2ba
Add a Humble release note about the include directory change. (#3703)…
mergify[bot] Jun 5, 2023
e3f0869
Fast-DDS uses SHM transport by default, so network traffic cannot be …
mergify[bot] Jun 5, 2023
05c2c62
[Iron] Add release notes for REP-2011 features (#3699) (#3713)
mergify[bot] Jun 6, 2023
a36b261
Update Introduction-To-Tf2.rst (#3484) (#3716)
mergify[bot] Jun 6, 2023
f665dbd
Pin the versions of the dependencies. (#2725) (#3720)
mergify[bot] Jun 7, 2023
31adf44
Get rid of unnecessary .rst prefixes in links. (#3723) (#3724)
mergify[bot] Jun 7, 2023
f61080c
Get rid of distribution name (#3701)
OTL Jun 9, 2023
8ca9729
Improve handling of dynamic discovery. (#3596) (#3731)
mergify[bot] Jun 10, 2023
2315c97
Import original sphinx_sitemap implementation as sphinx_sitemap_ros
Yadunund Jun 15, 2023
b1a83b0
Ignore pages with context containing skip_sitemap key
Yadunund Jun 15, 2023
6ddc5bb
Replace sphinx_sitemap extension with sphinx_sitemap_ros in conf.py
Yadunund Jun 15, 2023
254f17f
Rearrangement of the conceptual documents. (#3732) (#3746)
mergify[bot] Jun 20, 2023
27f0e32
Minor fixes to the URDF tutorial. (#3743) (#3747)
mergify[bot] Jun 21, 2023
c24a977
Foxy is now EOL (#3700) (#3750)
mergify[bot] Jun 21, 2023
4c24ade
Update Intel-ROS2-Projects.rst realsense was obsolet (#3753) (#3754)
mergify[bot] Jun 22, 2023
2166570
Update launch files to declare WebotsController node (#11) (#3763) (#…
mergify[bot] Jun 30, 2023
94e9a2c
New Reset Handler tutorial (#12) (#3764) (#3767)
mergify[bot] Jun 30, 2023
c37221c
Update macOS-Development-Setup.rst (#3758) (#3768)
mergify[bot] Jun 30, 2023
731f7d1
Change confusing title between Debian package and Debian platform (#3…
mergify[bot] Jul 4, 2023
c13d59d
Make the calendar more mobile-friendly. (#3774) (#3775)
mergify[bot] Jul 8, 2023
1a0d85d
Update documentation to correct default publishing mode (#3778) (#3781)
mergify[bot] Jul 12, 2023
e1a5795
update name of wg-security lead (#3779) (#3782)
mergify[bot] Jul 13, 2023
c64c05f
Add logger service description (#3477) (#3784)
mergify[bot] Jul 13, 2023
d5fd464
Update Using-ROS2-Launch-For-Large-Projects.rst (#3787) (#3788)
mergify[bot] Jul 18, 2023
ca7a2c2
Remove pre-configured Webots images for Rolling and Iron (#3794) (#3796)
mergify[bot] Jul 25, 2023
21432e0
Adding Jazzy Jalisco Timeline (#3760) (#3798)
mergify[bot] Jul 26, 2023
ab6008d
Enhancement Add Ros2Supervisor tutorial (#3790) (#3800)
mergify[bot] Jul 26, 2023
9f168f2
add discussion of ROS 1 style latched topics (#3804) (#3807)
mergify[bot] Jul 28, 2023
cbbce37
Revamp Roadmap for Jazzy (#3777) (#3808)
mergify[bot] Jul 31, 2023
6ef78f7
Fix numerous inconsistencies in ament-cmake-docs w.r.t installation o…
mergify[bot] Jul 31, 2023
0463a44
MinimumSocketReceiveBufferSize is moved (#3813) (#3814)
mergify[bot] Aug 3, 2023
00f293c
Major revamp of the ament_cmake documentation. (#3812) (#3816)
mergify[bot] Aug 4, 2023
19227e7
clarify eval escaping (#3793) (#3818)
mergify[bot] Aug 4, 2023
8795252
Improve rosdep: 1) Friendlier to beginners, 2) Clarifying rosdep is R…
mergify[bot] Aug 4, 2023
9150616
Prepare for ROS Answers migration to Robotics Stack Exchange. (#3823)…
mergify[bot] Aug 16, 2023
ddf09a9
Updates from today's TSC Meeting. Remove Samsung, change Canonical re…
mergify[bot] Aug 17, 2023
a39c332
Fix some instances of 'ROS2' (#3839) (#3842)
mergify[bot] Aug 18, 2023
b701e3b
Add in Intrinsic Jazzy Roadmap item. (#3826) (#3846)
mergify[bot] Aug 21, 2023
94522a4
add description to disallowed <arg> attributes when under <include> (…
mergify[bot] Aug 21, 2023
9b304d1
Update ROS Resources on Docs Index (#3825) (#3827)
mergify[bot] Aug 21, 2023
7528fe8
doc fix for rcutils environmental variables. (#3833) (#3850)
mergify[bot] Aug 21, 2023
dfe6b99
Improve eval documentation in migration guide (#3832) (#3852)
mergify[bot] Aug 21, 2023
3b3f2b7
Update control WG section (#3854) (#3855)
mergify[bot] Aug 21, 2023
36e3c4e
Fix Windows command in Creating-A-Workspace (#3860)
songyuc Aug 24, 2023
2eb6213
add Jazzy Roadmap features by Sony Corp. (#3865) (#3870)
mergify[bot] Aug 28, 2023
9e31f20
FIX:path of robot driver header (#3867) (#3871)
mergify[bot] Aug 28, 2023
5866506
Update real-time working group lead (#3873) (#3874)
mergify[bot] Aug 28, 2023
f76e9f7
fix typo about-actions.rst (#3877) (#3878)
mergify[bot] Aug 28, 2023
387ea2b
Change cite to literal text (#3866) (#3880)
mergify[bot] Aug 28, 2023
cd57adb
Tutorial for Reading from a Bag File in C++ (#3663) (#3885)
mergify[bot] Aug 30, 2023
20c77cb
Reorganize ROS 1 Migration Pages (#3861) (#3887)
mergify[bot] Aug 30, 2023
61eaaa5
Cleanup Working Groups (#3884) (#3889)
mergify[bot] Aug 30, 2023
e9e3df7
apply changes on reorganized files (#3858) (#3891)
mergify[bot] Aug 30, 2023
28ad639
Update Working-Groups.rst wil aerial robotics (#3895) (#3896)
mergify[bot] Sep 1, 2023
ffa3747
Updating ROS 2 Rust WG information (#3900) (#3901)
mergify[bot] Sep 5, 2023
533d7b6
Add instructions for debugging C++ tests in GDB when using colcon (#3…
mergify[bot] Sep 5, 2023
65492ea
Fix up the Pluginlib tutorial to not be Linux only. (#3905) (#3906)
mergify[bot] Sep 5, 2023
d7e8e27
Add a Windows disclaimer to the Rosdep page. (#3911) (#3912)
mergify[bot] Sep 11, 2023
5ce5658
GitHub trigger updated for just pull requests (#3882) (#3918)
mergify[bot] Sep 15, 2023
847c4e4
Update About-Nodes.rst (#3917) (#3924)
mergify[bot] Sep 18, 2023
2ba657d
Update Installation-Troubleshooting.rst (#3916) (#3927)
mergify[bot] Sep 19, 2023
d8ed20c
Update About-Actions.rst (#3928) (#3929)
mergify[bot] Sep 19, 2023
e8179d6
Add note about Python path to _Windows-Install-Prerequisites.rst (#39…
mergify[bot] Sep 20, 2023
ae4c641
Add UpstreamPackages to docs.ros.org documentation (#3824) (#3936)
mergify[bot] Sep 26, 2023
ae5187b
Update Working-Groups.rst (#3938) (#3940)
mergify[bot] Sep 26, 2023
44ed5c8
Fix typo in .svg (#3939) (#3942)
mergify[bot] Sep 27, 2023
03c1b0f
Updates Deliberation WG (#3944) (#3946)
mergify[bot] Sep 29, 2023
c876c47
Plugin Declaration XML: Simplify Lead Part (#3954) (#3955)
mergify[bot] Oct 8, 2023
65c742f
Small cleanups in the TF2 tutorials. (#3957) (#3958)
mergify[bot] Oct 9, 2023
3123535
fix: typo in Single-Package-Define-And-Use-Interface article (#3962) …
mergify[bot] Oct 10, 2023
f2bee9e
Fix punctuation error in Ubuntu-Install-Debians.rst (#3967) (#3968)
mergify[bot] Oct 14, 2023
fa6435d
Update PickNik logo (#3970) (#3972)
mergify[bot] Oct 17, 2023
6ee404c
Update Writing-A-Simple-Cpp-Service-And-Client.rst
maalsolami Oct 25, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 30 additions & 9 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,21 +1,42 @@
name: Test

on: [push, pull_request]
on: pull_request

jobs:
test:
runs-on: ubuntu-20.04
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v2
- name: Checkout
uses: actions/checkout@v3

- name: Setup Python
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: 3.8
python-version: '3.10'

- name: Install dependencies with pip
run: |
pip install --no-warn-script-location --user --upgrade -r requirements.txt
run: pip install --no-warn-script-location --user -r requirements.txt -c constraints.txt

- run: make html
- run: make test
- name: Test doc8
run: make test

build:
needs: test
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.10'

- name: Setup Graphviz
uses: ts-graphviz/setup-graphviz@v1

- name: Install dependencies with pip
run: pip install --no-warn-script-location --user -r requirements.txt -c constraints.txt

- name: Build the docs
run: make html
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
build/
plugins/__pycache__
_build/
.idea/
.vscode/
11 changes: 0 additions & 11 deletions .mergify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ pull_request_rules:
branches:
- iron
- humble
- foxy

- name: backport at reviewers discretion
conditions:
Expand All @@ -19,7 +18,6 @@ pull_request_rules:
branches:
- iron
- humble
- foxy

- name: backport to iron at reviewers discretion
conditions:
Expand All @@ -38,12 +36,3 @@ pull_request_rules:
backport:
branches:
- humble

- name: backport to foxy at reviewers discretion
conditions:
- base=rolling
- "label=backport-foxy"
actions:
backport:
branches:
- foxy
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ help:

multiversion: Makefile
sphinx-multiversion $(OPTS) "$(SOURCE)" build/html
@echo "<html><head><meta http-equiv=\"refresh\" content=\"0; url=humble/index.html\" /></head></html>" > build/html/index.html
@echo "<html><head><meta http-equiv=\"refresh\" content=\"0; url=iron/index.html\" /></head></html>" > build/html/index.html
python3 make_sitemapindex.py

%: Makefile
Expand Down
11 changes: 7 additions & 4 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
from docutils.parsers.rst import Directive

sys.path.append(os.path.abspath('./sphinx-multiversion'))
sys.path.append(os.path.abspath('plugins'))


# The suffix(es) of source filenames.
Expand Down Expand Up @@ -81,7 +82,7 @@
'sphinx_multiversion',
'sphinx_tabs.tabs',
'sphinx_rtd_theme',
'sphinx_sitemap',
'sphinx_sitemap_ros',
]

# Intersphinx mapping
Expand Down Expand Up @@ -125,10 +126,10 @@
smv_branch_whitelist = r'^(rolling|iron|humble|galactic|foxy|eloquent|dashing|crystal)$'


smv_released_pattern = r'^refs/(heads|remotes/[^/]+)/(humble|galactic|foxy|eloquent|dashing|crystal).*$'
smv_released_pattern = r'^refs/(heads|remotes/[^/]+)/(iron|humble|galactic|foxy|eloquent|dashing|crystal).*$'
smv_remote_whitelist = r'^(origin)$'
smv_latest_version = 'humble'
smv_eol_versions = ['crystal', 'dashing', 'eloquent', 'galactic']
smv_latest_version = 'iron'
smv_eol_versions = ['crystal', 'dashing', 'eloquent', 'foxy', 'galactic']

distro_full_names = {
'crystal': 'Crystal Clemmys',
Expand Down Expand Up @@ -238,6 +239,8 @@ def generate(cls, app):
'canonical_url': os.path.relpath(
canonical_url, redirect_url
),
# Skip entry into sitemap.xml with reason 'redirect'.
'skip_sitemap': 'redirect',
'title': os.path.basename(redirect_url),
'metatags': redirect_html_fragment.format(
base_url=app.config.html_baseurl,
Expand Down
30 changes: 30 additions & 0 deletions constraints.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Jinja2==3.0.3
MarkupSafe==2.0.1
Pygments==2.11.2
alabaster==0.7.12
babel==2.8.0
certifi==2020.6.20
chardet==4.0.0
imagesize==1.3.0
importlib-metadata==4.6.4
more-itertools==8.10.0
packaging==21.3
pbr==5.8.0
pip==22.0.2
pyparsing==2.4.7
pytz==2022.1
requests==2.25.1
restructuredtext-lint==1.3.2
roman==3.3
setuptools==59.6.0
six==1.16.0
snowballstemmer==2.2.0
Sphinx==4.3.2
sphinx-copybutton==0.4.0
sphinx-multiversion==0.2.4
sphinx-rtd-theme==1.0.0
sphinx-tabs==3.2.0
stevedore==3.5.0
urllib3==1.26.5
wheel==0.37.1
zipp==1.0.0
12 changes: 9 additions & 3 deletions docker/image/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# docker build -f docker/image/Dockerfile .

FROM ubuntu:focal
FROM ubuntu:jammy

ARG user=rosindex
ARG uid=1000
Expand All @@ -15,7 +15,13 @@ RUN apt-get update && \
git-all \
graphviz \
make \
python3-pip && \
python3-doc8 \
python3-docutils \
python3-pip \
python3-sphinx \
python3-sphinx-copybutton \
python3-sphinx-rtd-theme \
python3-sphinx-tabs && \
rm -rf /var/lib/apt/lists/*

RUN useradd -u $uid -m $user
Expand All @@ -25,4 +31,4 @@ WORKDIR /tmp/doc_repository

USER $user

CMD pip3 install --no-warn-script-location --user --upgrade -r requirements.txt && make multiversion
CMD pip3 install --no-warn-script-location --user -r requirements.txt -c constraints.txt && make multiversion
Loading