Merge pull request #2371 from VWS-Python/test-docs

Test shell snippets in documentation code blocks

Author: adamtheturtle

.pre-commit-config.yaml

@@ -30,6 +30,8 @@ ci:
         - spelling
         - vulture
         - vulture-docs
+        - shellcheck
+        - shellcheck-docs
 
 default_install_hook_types: [pre-commit, pre-push, commit-msg]
 repos:
@@ -49,11 +51,6 @@ repos:
     - id: file-contents-sorter
       files: spelling_private_dict\.txt$
     - id: trailing-whitespace
-- repo: https://github.com/shellcheck-py/shellcheck-py
-  rev: v0.10.0.1
-  hooks:
-    - id: shellcheck
-      args: ["--shell", "bash"]
 - repo: local
   hooks:
     - id: actionlint
@@ -63,6 +60,19 @@ repos:
       pass_filenames: false
       types_or: [yaml]
 
+    - id: shellcheck
+      name: shellcheck
+      entry: shellcheck --shell bash
+      language: system
+      pass_filenames: false
+      types_or: [shell]
+
+    - id: shellcheck-docs
+      name: shellcheck-docs
+      entry: doccmd --language=shell --language=console --command="shellcheck --shell=bash"
+      language: system
+      types_or: [markdown, rst]
+
     - id: mypy
       name: mypy
       stages: [push]

docs/source/index.rst

@@ -8,7 +8,7 @@ Installation
 
    $ pip install vws-python
 
-This is tested on Python 3.8+.
+This is tested on Python 3.12+.
 Get in touch with ``adamdangoor@gmail.com`` if you would like to use this with another language.
 
 Usage

docs/source/release-process.rst

@@ -17,6 +17,6 @@ Perform a Release
    .. code-block:: console
       :substitutions:
 
-      $ gh workflow run release.yml --repo |github-owner|/|github-repository|
+      $ gh workflow run release.yml --repo "|github-owner|/|github-repository|"
 
 .. _Install GitHub CLI: https://cli.github.com/