use py312 to build docs

Author: zariiii9003

.github/workflows/ci.yml

@@ -127,7 +127,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: "3.10"
+        python-version: "3.12"
     - name: Build documentation
       run: |
         pipx run tox -e docs

.readthedocs.yml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.10"
+    python: "3.12"
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

doc/development.rst

@@ -48,8 +48,7 @@ The unit tests can be run with::
 
 The documentation can be built with::
 
-    pip install -r doc/doc-requirements.txt
-    python -m sphinx -an doc build
+    pipx run tox -e docs
 
 The linters can be run with::
 

doc/scripts.rst

@@ -12,12 +12,14 @@ Command line help, called with ``--help``:
 
 
 .. command-output:: python -m can.logger -h
+    :shell:
 
 
 can.player
 ----------
 
 .. command-output:: python -m can.player -h
+    :shell:
 
 
 can.viewer
@@ -52,9 +54,11 @@ By default the ``can.viewer`` uses the :doc:`/interfaces/socketcan` interface. A
 The full usage page can be seen below:
 
 .. command-output:: python -m can.viewer -h
+    :shell:
 
 
 can.logconvert
 --------------
 
 .. command-output:: python -m can.logconvert -h
+    :shell:

tox.ini

@@ -30,15 +30,18 @@ passenv =
     TEST_SOCKETCAN
 
 [testenv:docs]
+description = Build and test the documentation
+basepython = py312
 deps =
     -r doc/doc-requirements.txt
+    gs-usb
 
 extras =
     canalystii
-    gs_usb
 
 commands =
-    python -m sphinx -an doc build
+    python -m sphinx -b html    -Wan --keep-going doc build
+    python -m sphinx -b doctest -W   --keep-going doc build
 
 
 [pytest]