Update docs

.github/workflows/tests.yml

@@ -100,7 +100,7 @@ jobs:
         - macOS-latest
         python-version:
         - '2.7'
-        #- '3.4'
+        - '3.4'
         - '3.5'
         - '3.6'
         - '3.7'

CHANGELOG.md

@@ -6,6 +6,9 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## Version 1.0.1 - Unreleased
 
+### Added
+* Add type stubs
+
 ### Fixed
 * Corner case bug in error reporting
 * Doctests that never run any code are now correctly marked as skipped 

docs/source/conf.py

@@ -147,7 +147,7 @@ def visit_Assign(self, node):
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

docs/source/xdoctest.docstr.rst

@@ -7,7 +7,6 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
-   xdoctest.docstr.convert_google_to_numpy
    xdoctest.docstr.docscrape_google
    xdoctest.docstr.docscrape_numpy
 

docs/source/xdoctest.global_state.rst

@@ -0,0 +1,7 @@
+xdoctest.global\_state module
+=============================
+
+.. automodule:: xdoctest.global_state
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/xdoctest.rst

@@ -25,6 +25,7 @@ Submodules
    xdoctest.doctest_part
    xdoctest.dynamic_analysis
    xdoctest.exceptions
+   xdoctest.global_state
    xdoctest.parser
    xdoctest.plugin
    xdoctest.runner

docs/source/xdoctest.utils.rst

@@ -7,6 +7,7 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
+   xdoctest.utils.util_deprecation
    xdoctest.utils.util_import
    xdoctest.utils.util_misc
    xdoctest.utils.util_mixins

docs/source/xdoctest.utils.util_deprecation.rst

@@ -0,0 +1,7 @@
+xdoctest.utils.util\_deprecation module
+=======================================
+
+.. automodule:: xdoctest.utils.util_deprecation
+   :members:
+   :undoc-members:
+   :show-inheritance:

xdoctest/docstr/docscrape_google.py

@@ -11,8 +11,8 @@
     * https://pypi.org/project/numpydoc/
 
 References:
-    [GoogleStyleDocs1] https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google
-    [GoogleStyleDocs2] http://www.sphinx-doc.org/en/stable/ext/example_google.html#example-google
+    .. [GoogleStyleDocs1] https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html#example-google
+    .. [GoogleStyleDocs2] http://www.sphinx-doc.org/en/stable/ext/example_google.html#example-google
 """
 from __future__ import absolute_import, division, print_function, unicode_literals
 import re

xdoctest/runner.py

@@ -110,15 +110,15 @@ def doctest_module(module_identifier=None, command=None, argv=None, exclude=[],
             The name of / path to the module, or the live module itself.
             If not specified, dynamic analysis will be used to introspect the
             module that called this function and that module will be used.
-            This can also contain the callname followed by the `::` token.
+            This can also contain the callname followed by the ``::`` token.
 
         command (str):
             determines which doctests to run.
             if command is None, this is determined by parsing sys.argv
             Value values are
-                'all' - find and run all tests in a module
-                'list' - list the tests in a module
-                'dump' - dumps tests to stdout
+            'all' - find and run all tests in a module
+            'list' - list the tests in a module
+            'dump' - dumps tests to stdout
 
         argv (List[str], default=None):
             if specified, command line flags that might influence beharior.
@@ -128,9 +128,9 @@ def doctest_module(module_identifier=None, command=None, argv=None, exclude=[],
 
         verbose (int, default=None):
             Verbosity level.
-                0 - disables all text
-                1 - minimal printing
-                3 - verbose printing
+            0 - disables all text
+            1 - minimal printing
+            3 - verbose printing
 
         exclude (List[str]):
             ignores any modname matching any of these glob-like patterns