summaryrefslogtreecommitdiff
path: root/.github/workflows/doctest.yml
diff options
context:
space:
mode:
authorengn33r <engn33r@users.noreply.github.com>2022-08-25 00:00:00 +0000
committerengn33r <engn33r@users.noreply.github.com>2022-08-25 00:00:00 +0000
commitd1500999d0918b87e09d9613773cb01d5dbc8609 (patch)
treecbbe0111a36a3b23e02f19af3b1a74ccaf72d5e7 /.github/workflows/doctest.yml
parent14b102d809295328fcf9fa87b396eff05b2d039f (diff)
downloadwebsocket-client-d1500999d0918b87e09d9613773cb01d5dbc8609.tar.gz
Add doctest CI to sphinx docs
Diffstat (limited to '.github/workflows/doctest.yml')
-rw-r--r--.github/workflows/doctest.yml20
1 files changed, 20 insertions, 0 deletions
diff --git a/.github/workflows/doctest.yml b/.github/workflows/doctest.yml
new file mode 100644
index 0000000..d2f680e
--- /dev/null
+++ b/.github/workflows/doctest.yml
@@ -0,0 +1,20 @@
+name: Run doctest on Sphinx docs
+
+on: [push, pull_request]
+
+jobs:
+ run-doctest:
+ runs-on: ubuntu-latest
+ name: doctest check
+ steps:
+ - name: Check out source repository
+ uses: actions/checkout@v2
+ - name: Set up Python ${{ matrix.python-version }} environment
+ uses: actions/setup-python@v2
+ with:
+ python-version: "3.10"
+
+ - name: Run pytest with doctest args
+ run: |
+ pip3 install pytest
+ pytest ./source -v --doctest-glob=examples.rst --doctest-modules