summaryrefslogtreecommitdiff
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
commit62ffdfe55c398869f61002c4b26b2da470d5c03f (patch)
treedf61c69d13431e04859bd12ed57e764ca1df4ba4
parent7a33095acd3a2e053b982cad3fbf07a5e5c9a124 (diff)
downloadwebsocket-client-62ffdfe55c398869f61002c4b26b2da470d5c03f.tar.gz
Fix doctest CI errors
-rw-r--r--.github/workflows/doctest.yml2
-rw-r--r--docs/source/faq.rst10
2 files changed, 6 insertions, 6 deletions
diff --git a/.github/workflows/doctest.yml b/.github/workflows/doctest.yml
index 0b7fcab..3478705 100644
--- a/.github/workflows/doctest.yml
+++ b/.github/workflows/doctest.yml
@@ -16,5 +16,5 @@ jobs:
- name: Run pytest with doctest args
run: |
- pip3 install pytest
+ pip3 install pytest 'websocket-client[optional]' rel
pytest ./docs/source -v --doctest-glob="*.rst" --doctest-modules
diff --git a/docs/source/faq.rst b/docs/source/faq.rst
index e10dbb5..b97a946 100644
--- a/docs/source/faq.rst
+++ b/docs/source/faq.rst
@@ -138,16 +138,16 @@ provided for all examples seen below.
.. doctest:: disable-ssl-verification
- >>> import websocket
+ >>> import websocket, ssl
>>> ws = websocket.WebSocketApp("wss://echo.websocket.events")
- >>> ws.run_forever(sslopt={"cert_reqs": ssl.CERT_NONE})
+ >>> ws.run_forever(sslopt={"cert_reqs": ssl.CERT_NONE}) # doctest: +SKIP
**create_connection example**
.. doctest:: disable-ssl-verification
- >>> import websocket
+ >>> import websocket, ssl
>>> ws = websocket.create_connection("wss://echo.websocket.events",
... sslopt={"cert_reqs": ssl.CERT_NONE})
@@ -155,7 +155,7 @@ provided for all examples seen below.
.. doctest:: disable-ssl-verification
- >>> import websocket
+ >>> import websocket, ssl
>>> ws = websocket.WebSocket(sslopt={"cert_reqs": ssl.CERT_NONE})
>>> ws.connect("wss://echo.websocket.events")
@@ -171,7 +171,7 @@ Please set sslopt to ``{"check_hostname": False}``. (since v0.18.0)
>>> import websocket
>>> ws = websocket.WebSocketApp("wss://echo.websocket.events")
- >>> ws.run_forever(sslopt={"check_hostname": False})
+ >>> ws.run_forever(sslopt={"check_hostname": False}) # doctest: +SKIP
**create_connection example**