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

sphinx references (backport #11) #12

Open
wants to merge 4 commits into
base: rolling
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 50 additions & 0 deletions .github/workflows/rebase-ros2_documentation.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: rebase-ros2_documentation

on:
schedule:
- cron: '0 0 * * *'
#scheduled every midnight
workflow_dispatch:
# manual run of the workflow job

jobs:
rebase-branches:
name: Rebase HEAD with upstream current branch
runs-on: ubuntu-latest
strategy:
matrix:
dest_branch: ['rolling', 'humble']

steps:
# Step 1: run a standard checkout action, provided by github (REQUIRED)
- name: Checkout target repo
uses: actions/checkout@v2
with:
ref: ${{ matrix.dest_branch }}
fetch-depth: 0

# Step 2: Set git config and add remote (REQUIRED)
- name: Set git config and add remote
id: config
run: |
git config --local user.email "[email protected]"
git config --local user.name "richiprosima"
git remote add ros https://github.com/ros2/ros2_documentation.git
shell: bash

# Step 3: Rebase
- name: Rebase current branch to upstream changes
id: rebase
run: |
git fetch ros ${{ matrix.dest_branch }}
git rebase ros/${{ matrix.dest_branch }}
shell: bash

# Step 4: Push
- name: Force push if required
id: push
run: |
if [ "$(git status | grep 'diverged\|ahead')" ]; then
git push -f
fi;
shell: bash
3 changes: 1 addition & 2 deletions source/Concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ The Core Stack Developer Concepts are much more detailed conceptual articles int
Concepts/About-Build-System
Concepts/About-Internal-Interfaces
Concepts/About-Middleware-Implementations
Concepts/About-ROS-2-Client-Libraries

Quick overview of ROS 2 Concepts
--------------------------------
Expand Down Expand Up @@ -95,7 +94,7 @@ It can be summarized as follows:
#. Nodes periodically advertise their presence so that connections can be made with new-found entities, even after the initial discovery period.
#. Nodes advertise to other nodes when they go offline.

Nodes will only establish connections with other nodes if they have compatible :doc:`Quality of Service <../Tutorials/Demos/Quality-of-Service>` settings.
Nodes will only establish connections with other nodes if they have compatible :doc:`Quality of Service <./Tutorials>` settings.

Take the :ref:`talker-listener demo <talker-listener>` for example.
Running the C++ talker node in one terminal will publish messages on a topic,
Expand Down
2 changes: 2 additions & 0 deletions source/Concepts/About-Different-Middleware-Vendors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

DDS-and-ROS-middleware-implementations

.. _concepts_ros2_vendors:

About different ROS 2 DDS/RTPS vendors
======================================

Expand Down
2 changes: 1 addition & 1 deletion source/How-To-Guides/Developing-a-ROS-2-Package.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ It is intended for developers who want to learn how to create custom packages in
Prerequisites
-------------

- :doc:`Install ROS <../../Installation>`
- :doc:`Install ROS <../Installation>`

- `Install colcon <https://colcon.readthedocs.io/en/released/user/installation.html>`__

Expand Down
2 changes: 1 addition & 1 deletion source/How-To-Guides/Releasing/_Next-Steps.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Once your pull request has been submitted, usually within one or two days, one of the maintainers of rosdistro will review and merge your Pull Request.
If your package build is successful, in 24-48 hours your packages will become available in the **ros-testing** repository, where you can :doc:`test your pre-release binaries <../../../Installation/Testing>`.
If your package build is successful, in 24-48 hours your packages will become available in the **ros-testing** repository, where you can :doc:`test your pre-release binaries <../../Installation/Testing>`.

Approximately every two to four weeks, the distribution's release manager manually synchronizes the contents of ros-testing into the main ROS repository.
This is when your packages actually become available to the rest of the ROS community.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 0 additions & 7 deletions source/Installation/Maintaining-a-Source-Checkout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,6 @@
Maintain source checkout
========================

.. ifconfig:: smv_current_version != '' and smv_current_version != 'rolling'

.. note::

For instructions on maintaining a source checkout of the **latest development version** of ROS 2, refer to
`Maintaining a source checkout of ROS 2 Rolling <../../rolling/Installation/Maintaining-a-Source-Checkout.html>`__

.. contents::
:depth: 2
:local:
Expand Down
2 changes: 1 addition & 1 deletion source/Installation/RHEL-Install-RPMs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Hooray!

Next steps after installing
---------------------------
Continue with the :doc:`tutorials and demos <../../Tutorials>` to configure your environment, create your own workspace and packages, and learn ROS 2 core concepts.
Continue with the :doc:`tutorials and demos <../Tutorials>` to configure your environment, create your own workspace and packages, and learn ROS 2 core concepts.

Additional RMW implementations (optional)
-----------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion source/Installation/Ubuntu-Install-Debians.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Hooray!

Next steps after installing
---------------------------
Continue with the :doc:`tutorials and demos <../../Tutorials>` to configure your environment, create your own workspace and packages, and learn ROS 2 core concepts.
Continue with the :doc:`tutorials and demos <../Tutorials>` to configure your environment, create your own workspace and packages, and learn ROS 2 core concepts.

Using the ROS 1 bridge
----------------------
Expand Down
2 changes: 1 addition & 1 deletion source/Installation/Windows-Install-Binary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Hooray!

Next steps after installing
---------------------------
Continue with the :doc:`tutorials and demos <../../Tutorials>` to configure your environment, create your own workspace and packages, and learn ROS 2 core concepts.
Continue with the :doc:`tutorials and demos <../Tutorials>` to configure your environment, create your own workspace and packages, and learn ROS 2 core concepts.

Additional RMW implementations (optional)
-----------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion source/Installation/_Windows-Install-Prerequisites.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Make sure that the Visual C++ features are installed.

An easy way to make sure they're installed is to select the ``Desktop development with C++`` workflow during the install.

.. image:: /Installation/images/windows-vs-studio-install.png
.. image:: ./images/windows-vs-studio-install.png

Make sure that no C++ CMake tools are installed by unselecting them in the list of components to be installed.

Expand Down
2 changes: 1 addition & 1 deletion source/Releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -176,4 +176,4 @@ As the name implies, Rolling is continuously updated and **can have in-place upd
We recommend that most people use the most recent stable distribution instead (see :ref:`list_of_distributions`).

Packages released into the Rolling distribution will be automatically released into future stable distributions of ROS 2.
:doc:`Releasing a ROS 2 package <../How-To-Guides/Releasing/Releasing-a-Package>` into the Rolling distribution follows the same procedures as all other ROS 2 distributions.
:doc:`Releasing a ROS 2 package <./How-To-Guides/Releasing/Releasing-a-Package>` into the Rolling distribution follows the same procedures as all other ROS 2 distributions.
2 changes: 1 addition & 1 deletion source/The-ROS2-Project/Contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Discussions and support
-----------------------

Some of the easiest ways to contribute to ROS 2 involve engaging in community discussions and support.
You can find more information on how to pitch in on the :doc:`Contact <../../Contact>` page.
You can find more information on how to pitch in on the :doc:`Contact <../Contact>` page.

Contributing code
-----------------
Expand Down
2 changes: 1 addition & 1 deletion source/Tutorials/Advanced/Simulators/Ignition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ You have two options:
- Install from deb packages. To check which versions are available from deb packages please check this `table <https://github.com/ignitionrobotics/ros_ign>`__.
- Compile from sources:

- :doc:`ROS 2 install instructions <../../../../Installation>`
- :doc:`ROS 2 install instructions <../../../Installation>`
- `Ignition install instructions <https://gazebosim.org/docs>`__

Tasks
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Tutorials/Monitoring-For-Parameter-Changes-CPP

.. _intermediate_monitor_parameters:

Monitoring for parameter changes (C++)
======================================

Expand Down