diff --git a/.github/workflows/jazzy-check-docs.yml b/.github/workflows/jazzy-check-docs.yml new file mode 100644 index 00000000..4bc94a23 --- /dev/null +++ b/.github/workflows/jazzy-check-docs.yml @@ -0,0 +1,29 @@ +name: Jazzy Check Docs + +on: + workflow_dispatch: + pull_request: + branches: + - jazzy + paths: + - '**.rst' + - '**.md' + - '**.jpg' + - '**.jpeg' + - '**.png' + - '**.svg' + - '**.yml' + - '**.yaml' + - '!.github/**' # exclude yaml files in .github directory + - '.github/workflows/jazzy-check-docs.yml' + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + check-docs: + name: Check Docs + uses: ros-controls/control.ros.org/.github/workflows/reusable-sphinx-check-single-version.yml@jazzy + with: + CONTROL_TOOLBOX_PR: ${{ github.ref }} diff --git a/.github/workflows/rolling-check-docs.yml b/.github/workflows/rolling-check-docs.yml new file mode 100644 index 00000000..4fa0320b --- /dev/null +++ b/.github/workflows/rolling-check-docs.yml @@ -0,0 +1,29 @@ +name: Rolling Check Docs + +on: + workflow_dispatch: + pull_request: + branches: + - ros2-master + paths: + - '**.rst' + - '**.md' + - '**.jpg' + - '**.jpeg' + - '**.png' + - '**.svg' + - '**.yml' + - '**.yaml' + - '!.github/**' # exclude yaml files in .github directory + - '.github/workflows/rolling-check-docs.yml' + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + check-docs: + name: Check Docs + uses: ros-controls/control.ros.org/.github/workflows/reusable-sphinx-check-single-version.yml@rolling + with: + CONTROL_TOOLBOX_PR: ${{ github.ref }} diff --git a/doc/migration.rst b/doc/migration.rst index 3d5ab630..12bf34ec 100644 --- a/doc/migration.rst +++ b/doc/migration.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/ros-controls/realtime_tools/blob/{REPOS_FILE_BRANCH}/doc/migration.rst +:github_url: https://github.com/ros-controls/control_toolbox/blob/{REPOS_FILE_BRANCH}/doc/migration.rst Migration Guides: Jazzy to Kilted ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -6,4 +6,4 @@ This list summarizes important changes between Jazzy (previous) and Kilted (curr Pid/PidRos *********************************************************** -* The parameters :paramref:`antiwindup`, :paramref:`i_clamp_max`, and :paramref:`i_clamp_min` have been removed. The anti-windup behavior is now configured via the :paramref:`AntiWindupStrategy` enum. (`#298 `_). +* The parameters ``antiwindup``, ``i_clamp_max``, and ``i_clamp_min`` have been removed. The anti-windup behavior is now configured via the ``AntiWindupStrategy`` enum. (`#298 `_). diff --git a/doc/release_notes.rst b/doc/release_notes.rst index 5e34fc1e..254400c5 100644 --- a/doc/release_notes.rst +++ b/doc/release_notes.rst @@ -1,4 +1,4 @@ -:github_url: https://github.com/ros-controls/realtime_tools/blob/{REPOS_FILE_BRANCH}/doc/release_notes.rst +:github_url: https://github.com/ros-controls/control_toolbox/blob/{REPOS_FILE_BRANCH}/doc/release_notes.rst Release Notes: Jazzy to Kilted ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^