add README doctests to tox tests and github actions

Author: astanin

.github/workflows/tabulate.yml

@@ -26,7 +26,7 @@ jobs:
         python -m pip install pytest pytest-cov numpy pandas "wcwidth>=0.6.0"
     - name: Run tests
       run: |
-        pytest -v --doctest-modules --ignore benchmark --cov=tabulate --cov-branch --cov-report=xml
+        pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" --cov=tabulate --cov-branch --cov-report=xml
     - name: Upload coverage reports to Codecov
       uses: codecov/codecov-action@v5
       with:

tox.ini

@@ -20,7 +20,7 @@ python =
     3.14: py314-extra
 
 [testenv]
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
 passenv =
@@ -37,13 +37,13 @@ deps =
 
 [testenv:py38]
 basepython = python3.8
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
 
 [testenv:py38-extra]
 basepython = python3.8
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
     numpy
@@ -53,13 +53,13 @@ deps =
 
 [testenv:py39]
 basepython = python3.9
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
 
 [testenv:py39-extra]
 basepython = python3.9
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
     numpy
@@ -69,14 +69,14 @@ deps =
 
 [testenv:py310]
 basepython = python3.10
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
 
 [testenv:py310-extra]
 basepython = python3.10
 setenv = PYTHONDEVMODE = 1
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
     numpy
@@ -86,14 +86,14 @@ deps =
 
 [testenv:py311]
 basepython = python3.11
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
 
 [testenv:py311-extra]
 basepython = python3.11
 setenv = PYTHONDEVMODE = 1
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
     numpy
@@ -102,14 +102,14 @@ deps =
 
 [testenv:py312]
 basepython = python3.12
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
 
 [testenv:py312-extra]
 basepython = python3.12
 setenv = PYTHONDEVMODE = 1
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
     numpy
@@ -118,14 +118,14 @@ deps =
 
 [testenv:py313]
 basepython = python3.13
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
 
 [testenv:py313-extra]
 basepython = python3.13
 setenv = PYTHONDEVMODE = 1
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
     numpy
@@ -134,14 +134,14 @@ deps =
 
 [testenv:py314]
 basepython = python3.14
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
 
 [testenv:py314-extra]
 basepython = python3.14
 setenv = PYTHONDEVMODE = 1
-commands = pytest -v --doctest-modules --ignore benchmark {posargs}
+commands = pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" {posargs}
 deps =
     pytest
     numpy