Add rstcheck to pre-commit (#4755)

* Introduce rstcheck

* Fix rstcheck errors

* Add changelog

* Fix link to PR

Author: xrmx

.pre-commit-config.yaml

@@ -13,3 +13,9 @@ repos:
     rev: 0.6.0
     hooks:
       - id: uv-lock
+  - repo: https://github.com/rstcheck/rstcheck
+    rev: 77490ffa33bfc0928975ae3cf904219903db755d # frozen: v6.2.5
+    hooks:
+      - id: rstcheck
+        additional_dependencies: ['rstcheck[sphinx]']
+        args: ["--report-level", "warning"]

.rstcheck.cfg

@@ -0,0 +1,3 @@
+[rstcheck]
+ignore_directives = automodule
+ignore_roles = scm_web,scm_raw_web

CHANGELOG.md

@@ -12,6 +12,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- Add `rstcheck` to pre-commit to stop introducing invalid RST
+  ([#4755](https://github.com/open-telemetry/opentelemetry-python/pull/4755))
+
 ## Version 1.37.0/0.58b0 (2025-09-11)
 
 - Add experimental composite samplers

CONTRIBUTING.md

@@ -72,7 +72,7 @@ You can run `tox` with the following arguments:
 - `tox -e tracecontext` to run integration tests for tracecontext.
 - `tox -e precommit` to run all `pre-commit` actions
 
-`ruff check` and `ruff format` are executed when `tox -e ruff` is run. We strongly recommend you to configure [pre-commit](https://pre-commit.com/) locally to run `ruff` automatically before each commit by installing it as git hooks. You just need to [install pre-commit](https://pre-commit.com/#install) in your environment:
+`ruff check` and `ruff format` are executed when `tox -e ruff` is run. We strongly recommend you to configure [pre-commit](https://pre-commit.com/) locally to run `ruff` and `rstcheck` automatically before each commit by installing it as git hooks. You just need to [install pre-commit](https://pre-commit.com/#install) in your environment:
 
 ```console
 pip install pre-commit -c dev-requirements.txt

shim/opentelemetry-opentracing-shim/tests/testbed/test_multiple_callbacks/README.rst

@@ -38,7 +38,7 @@ Implementation details:
            with self.tracer.start_active_span("task"):
                await asyncio.sleep(interval)
 
-       # Invoke and yield over the corotuines.
-       with self.tracer.start_active_span("parent"):
-       tasks = self.submit_callbacks()
-       await asyncio.gather(*tasks)
+           # Invoke and yield over the coroutines.
+           with self.tracer.start_active_span("parent"):
+               tasks = self.submit_callbacks()
+               await asyncio.gather(*tasks)