Merge pull request #209 from python-greenlet/issue204

Convert most documentation examples to doctests and run them on CI and tox

.travis.yml

@@ -15,6 +15,8 @@ python:
   - 3.8
   - 3.9
 
-install: pip install -U -e .[test]
+install: pip install -U -e .[test,docs]
 
-script: python -m unittest discover -v greenlet.tests
+script:
+  - python -m unittest discover -v greenlet.tests
+  - sphinx-build -b doctest -d docs/_build/doctrees2 docs docs/_build/doctest2

appveyor.yml

@@ -146,11 +146,12 @@ install:
   - "%CMD_IN_ENV% pip install --upgrade -r dev-requirements.txt"
 
 build_script:
-  - "%CMD_IN_ENV% python -m pip install -U -e .[test]"
+  - "%CMD_IN_ENV% python -m pip install -U -e .[test,docs]"
 
 
 test_script:
   - "%CMD_IN_ENV% python -m unittest discover -v greenlet.tests"
+  - "%CMD_IN_ENV% python -m sphinx -b doctest -d docs/_build/doctrees docs docs/_build/doctest"
 
 after_test:
   - "%CMD_IN_ENV% python setup.py bdist_wheel"

docs/conf.py

@@ -76,7 +76,7 @@
 exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+default_role = "obj"
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 #add_function_parentheses = True