From 4fc7bdbe5f21eb8775bd2b5cefa970238d2745cd Mon Sep 17 00:00:00 2001 From: Felix Exner Date: Tue, 4 Jun 2024 11:28:49 +0200 Subject: [PATCH] Add pre-commit job for sphinx linter --- .pre-commit-config.yaml | 4 ++++ doc/installation.rst | 2 +- doc/real_time.rst | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index cf974482..1d98db09 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,3 +8,7 @@ repos: hooks: - id: markdownlint-cli2 exclude: "include/ur_client_library/queue/LICENSE.md" + - repo: https://github.com/sphinx-contrib/sphinx-lint + rev: v0.9.1 + hooks: + - id: sphinx-lint diff --git a/doc/installation.rst b/doc/installation.rst index 9f9ec223..4e9e6db3 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -25,7 +25,7 @@ The ``ur_client_library`` is available in all maintained ROS distribution and ca using .. code-block:: console - + $ sudo apt install ros--ur-client-library Unless you explicitly want to contribute to this library we recommend using the binary installation diff --git a/doc/real_time.rst b/doc/real_time.rst index 0471d47c..caae7528 100644 --- a/doc/real_time.rst +++ b/doc/real_time.rst @@ -299,7 +299,7 @@ Make sure that the kernel does indeed support real-time scheduling: .. code-block:: console - $ uname -v | cut -d" " -f1-4 + $ uname -v | cut -d" " -f1-4 #1 SMP PREEMPT_RT Tue Optional: Disable CPU speed scaling