Merge pull request #121 from Erotemic/dev/pre-1.0.0

Bump to 0.99.99

.github/workflows/tests.yml

@@ -316,8 +316,8 @@ jobs:
     # Publish on the test PyPI
     name: Uploading to Test PyPi
     runs-on: ubuntu-latest
-    #if: github.event_name == 'push' && (startsWith(github.event.ref, 'refs/heads/main') || startsWith(github.event.ref, 'refs/heads/master'))
-    if: github.event_name == 'push'
+    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/heads/main') 
+    #if: github.event_name == 'push'
     #&& !startsWith(github.event.ref, 'refs/tags')
     needs: [build_and_test_wheels, build_and_test_sdist]
     steps:

README.rst

@@ -396,6 +396,45 @@ to transform your ``xdoctest`` into a ``unittest`` when you realize your
 doctests are getting too long.
 
 
+One Last Example
+----------------
+
+XDoctest is a good demonstration of itself. After pip installing xdoctest, try
+running xdoctest on xdoctest.
+
+.. code:: bash
+
+    xdoctest xdoctest
+
+If you would like a slightly less verbose output, try
+
+.. code:: bash
+
+    xdoctest xdoctest --verbose=1
+
+    # or
+
+    xdoctest xdoctest --verbose=0
+
+
+You could also consider running xdoctests tests through pytest:
+
+
+.. code:: bash
+
+    pytest $(python -c 'import xdoctest, pathlib; print(pathlib.Path(xdoctest.__file__).parent)') --xdoctest
+
+
+If you would like a slightly more verbose output, try
+
+.. code:: bash
+
+    pytest -s --verbose --xdoctest-verbose=3 --xdoctest $(python -c 'import xdoctest, pathlib; print(pathlib.Path(xdoctest.__file__).parent)') 
+    
+
+If you ran these commands, the myriad of characters that flew across your
+screen are lots more examples of what you can do with doctests.
+
 
 .. |CircleCI| image:: https://circleci.com/gh/Erotemic/xdoctest.svg?style=svg
     :target: https://circleci.com/gh/Erotemic/xdoctest

xdoctest/__init__.py

@@ -160,7 +160,6 @@ def fib(n):
 It is recommended to use pytest for automatic testing (e.g. in your CI
 scripts), but for debugging it may be easier to use the native interface.
 
-
 Using the pytest interface
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -271,6 +270,43 @@ def fib(n):
    doctests or functions without any arguments (zero-args) this way.
 
 
+XDoctest is a good demonstration of itself. After pip installing xdoctest, try
+running xdoctest on xdoctest.
+
+.. code:: bash
+
+    xdoctest xdoctest
+
+If you would like a slightly less verbose output, try
+
+.. code:: bash
+
+    xdoctest xdoctest --verbose=1
+
+    # or
+
+    xdoctest xdoctest --verbose=0
+
+
+You could also consider running xdoctests tests through pytest:
+
+
+.. code:: bash
+
+    pytest $(python -c 'import xdoctest, pathlib; print(pathlib.Path(xdoctest.__file__).parent)') --xdoctest
+
+
+If you would like a slightly more verbose output, try
+
+.. code:: bash
+
+    pytest -s --verbose --xdoctest-verbose=3 --xdoctest $(python -c 'import xdoctest, pathlib; print(pathlib.Path(xdoctest.__file__).parent)')
+
+
+If you ran these commands, the myriad of characters that flew across your
+screen are lots more examples of what you can do with doctests.
+
+
 You can also run doctests
 :doc:`inside Jupyter Notebooks <../xdoc_with_jupyter>`.
 '''
@@ -280,7 +316,7 @@ def fib(n):
 mkinit xdoctest --nomods
 '''
 
-__version__ = '0.15.11'
+__version__ = '0.99.99'
 
 
 # Expose only select submodules