Skip to content

Commit 3671fbe

Browse files
authored
Add CI job for docs (backport #424) (#427)
1 parent 70ab77c commit 3671fbe

File tree

4 files changed

+61
-3
lines changed

4 files changed

+61
-3
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Jazzy Check Docs
2+
3+
on:
4+
workflow_dispatch:
5+
pull_request:
6+
branches:
7+
- jazzy
8+
paths:
9+
- '**.rst'
10+
- '**.md'
11+
- '**.jpg'
12+
- '**.jpeg'
13+
- '**.png'
14+
- '**.svg'
15+
- '**.yml'
16+
- '**.yaml'
17+
- '!.github/**' # exclude yaml files in .github directory
18+
- '.github/workflows/jazzy-check-docs.yml'
19+
20+
concurrency:
21+
group: ${{ github.workflow }}-${{ github.ref }}
22+
cancel-in-progress: true
23+
24+
jobs:
25+
check-docs:
26+
name: Check Docs
27+
uses: ros-controls/control.ros.org/.github/workflows/reusable-sphinx-check-single-version.yml@jazzy
28+
with:
29+
CONTROL_TOOLBOX_PR: ${{ github.ref }}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Rolling Check Docs
2+
3+
on:
4+
workflow_dispatch:
5+
pull_request:
6+
branches:
7+
- ros2-master
8+
paths:
9+
- '**.rst'
10+
- '**.md'
11+
- '**.jpg'
12+
- '**.jpeg'
13+
- '**.png'
14+
- '**.svg'
15+
- '**.yml'
16+
- '**.yaml'
17+
- '!.github/**' # exclude yaml files in .github directory
18+
- '.github/workflows/rolling-check-docs.yml'
19+
20+
concurrency:
21+
group: ${{ github.workflow }}-${{ github.ref }}
22+
cancel-in-progress: true
23+
24+
jobs:
25+
check-docs:
26+
name: Check Docs
27+
uses: ros-controls/control.ros.org/.github/workflows/reusable-sphinx-check-single-version.yml@rolling
28+
with:
29+
CONTROL_TOOLBOX_PR: ${{ github.ref }}

doc/migration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
:github_url: https://github.com/ros-controls/realtime_tools/blob/{REPOS_FILE_BRANCH}/doc/migration.rst
1+
:github_url: https://github.com/ros-controls/control_toolbox/blob/{REPOS_FILE_BRANCH}/doc/migration.rst
22

33
Migration Guides: Humble to Jazzy
44
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -10,4 +10,4 @@ This list summarizes important changes between Humble (previous) and Jazzy (curr
1010

1111
Pid/PidRos
1212
***********************************************************
13-
* The parameters :paramref:`antiwindup`, :paramref:`i_clamp_max`, and :paramref:`i_clamp_min` will be removed. The anti-windup behavior is now configured via the :paramref:`AntiWindupStrategy` enum. (`#298 <https://github.com/ros-controls/control_toolbox/pull/298>`_).
13+
* The parameters ``antiwindup``, ``i_clamp_max``, and ``i_clamp_min`` will be removed. The anti-windup behavior is now configured via the ``AntiWindupStrategy`` enum. (`#298 <https://github.com/ros-controls/control_toolbox/pull/298>`_).

doc/release_notes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
:github_url: https://github.com/ros-controls/realtime_tools/blob/{REPOS_FILE_BRANCH}/doc/release_notes.rst
1+
:github_url: https://github.com/ros-controls/control_toolbox/blob/{REPOS_FILE_BRANCH}/doc/release_notes.rst
22

33
Release Notes: Humble to Jazzy
44
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)