Script 'mail_helper' called by obssrc Hello community, here is the log from the commit of package python-xdoctest for openSUSE:Factory checked in at 2024-08-19 23:45:15 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Comparing /work/SRC/openSUSE:Factory/python-xdoctest (Old) and /work/SRC/openSUSE:Factory/.python-xdoctest.new.2698 (New) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Package is "python-xdoctest" Mon Aug 19 23:45:15 2024 rev:7 rq:1194647 version:1.1.6 Changes: -------- --- /work/SRC/openSUSE:Factory/python-xdoctest/python-xdoctest.changes 2024-06-14 19:05:55.971931875 +0200 +++ /work/SRC/openSUSE:Factory/.python-xdoctest.new.2698/python-xdoctest.changes 2024-08-19 23:46:01.551449244 +0200 @@ -1,0 +2,7 @@ +Mon Aug 19 07:09:36 UTC 2024 - Dirk Müller <dmueller@suse.com> + +- update to 1.1.6: + * Fixed passing of `flags` as keyword argument to `re.sub` for + python 3.13 compliance. + +------------------------------------------------------------------- Old: ---- xdoctest-1.1.5.tar.gz New: ---- xdoctest-1.1.6.tar.gz ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Other differences: ------------------ ++++++ python-xdoctest.spec ++++++ --- /var/tmp/diff_new_pack.8TdM6M/_old 2024-08-19 23:46:02.671496140 +0200 +++ /var/tmp/diff_new_pack.8TdM6M/_new 2024-08-19 23:46:02.675496308 +0200 @@ -17,7 +17,7 @@ Name: python-xdoctest -Version: 1.1.5 +Version: 1.1.6 Release: 0 Summary: Enhanced Python builtin doctest module License: Apache-2.0 ++++++ xdoctest-1.1.5.tar.gz -> xdoctest-1.1.6.tar.gz ++++++ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/CHANGELOG.md new/xdoctest-1.1.6/CHANGELOG.md --- old/xdoctest-1.1.5/CHANGELOG.md 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/CHANGELOG.md 2024-08-01 19:21:41.000000000 +0200 @@ -5,13 +5,19 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## Version 1.1.5 - Unreleased +## Version 1.1.6 - Unreleased + +### Fixed +* Fixed passing of `flags` as keyword argument to `re.sub` for python 3.13 compliance. + + +## Version 1.1.5 - Released 2024-06-07 ### Changed * Minor modification to `xdoctest --version-info` and exposed it in CLI help. ### Fixed -* `ub.modname_to_modpath` fixed in cases where editable installs use type annotations in their MAPPING definition. +* `modname_to_modpath` fixed in cases where editable installs use type annotations in their MAPPING definition. ## Version 1.1.4 - Released 2024-05-31 diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/dev/maintain/port_ubelt_utils.py new/xdoctest-1.1.6/dev/maintain/port_ubelt_utils.py --- old/xdoctest-1.1.5/dev/maintain/port_ubelt_utils.py 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/dev/maintain/port_ubelt_utils.py 2024-08-01 19:21:41.000000000 +0200 @@ -1,5 +1,10 @@ """ Statically ports utilities from ubelt needed by xdoctest. + +Similar Scripts: + ~/code/xdoctest/dev/maintain/port_ubelt_utils.py + ~/code/mkinit/dev/maintain/port_ubelt_code.py + ~/code/line_profiler/dev/maintain/port_utilities.py """ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/modules.rst new/xdoctest-1.1.6/docs/source/auto/modules.rst --- old/xdoctest-1.1.5/docs/source/auto/modules.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/modules.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,7 @@ +xdoctest +======== + +.. toctree:: + :maxdepth: 4 + + xdoctest diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.__main__.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.__main__.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.__main__.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.__main__.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.\_\_main\_\_ module +============================ + +.. automodule:: xdoctest.__main__ + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest._tokenize.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest._tokenize.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest._tokenize.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest._tokenize.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.\_tokenize module +========================== + +.. automodule:: xdoctest._tokenize + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.checker.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.checker.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.checker.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.checker.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.checker module +======================= + +.. automodule:: xdoctest.checker + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.constants.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.constants.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.constants.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.constants.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.constants module +========================= + +.. automodule:: xdoctest.constants + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.core.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.core.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.core.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.core.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.core module +==================== + +.. automodule:: xdoctest.core + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.demo.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.demo.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.demo.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.demo.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.demo module +==================== + +.. automodule:: xdoctest.demo + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.directive.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.directive.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.directive.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.directive.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.directive module +========================= + +.. automodule:: xdoctest.directive + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.docstr.docscrape_google.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.docstr.docscrape_google.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.docstr.docscrape_google.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.docstr.docscrape_google.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.docstr.docscrape\_google module +======================================== + +.. automodule:: xdoctest.docstr.docscrape_google + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.docstr.docscrape_numpy.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.docstr.docscrape_numpy.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.docstr.docscrape_numpy.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.docstr.docscrape_numpy.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.docstr.docscrape\_numpy module +======================================= + +.. automodule:: xdoctest.docstr.docscrape_numpy + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.docstr.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.docstr.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.docstr.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.docstr.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,20 @@ +xdoctest.docstr package +======================= + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + xdoctest.docstr.docscrape_google + xdoctest.docstr.docscrape_numpy + +Module contents +--------------- + +.. automodule:: xdoctest.docstr + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.doctest_example.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.doctest_example.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.doctest_example.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.doctest_example.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.doctest\_example module +================================ + +.. automodule:: xdoctest.doctest_example + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.doctest_part.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.doctest_part.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.doctest_part.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.doctest_part.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.doctest\_part module +============================= + +.. automodule:: xdoctest.doctest_part + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.dynamic_analysis.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.dynamic_analysis.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.dynamic_analysis.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.dynamic_analysis.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.dynamic\_analysis module +================================= + +.. automodule:: xdoctest.dynamic_analysis + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.exceptions.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.exceptions.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.exceptions.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.exceptions.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.exceptions module +========================== + +.. automodule:: xdoctest.exceptions + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.global_state.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.global_state.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.global_state.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.global_state.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.global\_state module +============================= + +.. automodule:: xdoctest.global_state + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.parser.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.parser.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.parser.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.parser.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.parser module +====================== + +.. automodule:: xdoctest.parser + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.plugin.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.plugin.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.plugin.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.plugin.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.plugin module +====================== + +.. automodule:: xdoctest.plugin + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,43 @@ +xdoctest package +================ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + xdoctest.docstr + xdoctest.utils + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + xdoctest.__main__ + xdoctest._tokenize + xdoctest.checker + xdoctest.constants + xdoctest.core + xdoctest.demo + xdoctest.directive + xdoctest.doctest_example + xdoctest.doctest_part + xdoctest.dynamic_analysis + xdoctest.exceptions + xdoctest.global_state + xdoctest.parser + xdoctest.plugin + xdoctest.runner + xdoctest.static_analysis + +Module contents +--------------- + +.. automodule:: xdoctest + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.runner.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.runner.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.runner.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.runner.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.runner module +====================== + +.. automodule:: xdoctest.runner + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.static_analysis.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.static_analysis.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.static_analysis.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.static_analysis.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.static\_analysis module +================================ + +.. automodule:: xdoctest.static_analysis + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,26 @@ +xdoctest.utils package +====================== + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + xdoctest.utils.util_deprecation + xdoctest.utils.util_import + xdoctest.utils.util_misc + xdoctest.utils.util_mixins + xdoctest.utils.util_notebook + xdoctest.utils.util_path + xdoctest.utils.util_str + xdoctest.utils.util_stream + +Module contents +--------------- + +.. automodule:: xdoctest.utils + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_deprecation.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_deprecation.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_deprecation.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_deprecation.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.utils.util\_deprecation module +======================================= + +.. automodule:: xdoctest.utils.util_deprecation + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_import.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_import.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_import.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_import.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.utils.util\_import module +================================== + +.. automodule:: xdoctest.utils.util_import + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_misc.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_misc.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_misc.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_misc.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.utils.util\_misc module +================================ + +.. automodule:: xdoctest.utils.util_misc + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_mixins.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_mixins.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_mixins.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_mixins.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.utils.util\_mixins module +================================== + +.. automodule:: xdoctest.utils.util_mixins + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_notebook.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_notebook.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_notebook.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_notebook.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.utils.util\_notebook module +==================================== + +.. automodule:: xdoctest.utils.util_notebook + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_path.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_path.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_path.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_path.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.utils.util\_path module +================================ + +.. automodule:: xdoctest.utils.util_path + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_str.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_str.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_str.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_str.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.utils.util\_str module +=============================== + +.. automodule:: xdoctest.utils.util_str + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_stream.rst new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_stream.rst --- old/xdoctest-1.1.5/docs/source/auto/xdoctest.utils.util_stream.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/auto/xdoctest.utils.util_stream.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,8 @@ +xdoctest.utils.util\_stream module +================================== + +.. automodule:: xdoctest.utils.util_stream + :members: + :undoc-members: + :show-inheritance: + :private-members: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/conf.py new/xdoctest-1.1.6/docs/source/conf.py --- old/xdoctest-1.1.5/docs/source/conf.py 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/conf.py 2024-08-01 19:21:41.000000000 +0200 @@ -17,7 +17,7 @@ # need to edit the conf.py cd ~/code/xdoctest/docs - sphinx-apidoc --private --separate -f -o ~/code/xdoctest/docs/source/auto ~/code/xdoctest/src/xdoctest '_tokenize.py' + sphinx-apidoc --private --separate --force --output-dir ~/code/xdoctest/docs/source/auto ~/code/xdoctest/src/xdoctest '_tokenize.py' # Note: the module should importable before running this # (e.g. install it in developer mode or munge the PYTHONPATH) diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/index.rst new/xdoctest-1.1.6/docs/source/index.rst --- old/xdoctest-1.1.5/docs/source/index.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/index.rst 2024-08-01 19:21:41.000000000 +0200 @@ -1,5 +1,3 @@ -.. This file is no longer used, we redirect to autoapi/xdoctest/index.html - :github_url: https://github.com/Erotemic/xdoctest .. The __init__ files contains the top-level documentation overview @@ -10,7 +8,7 @@ :maxdepth: 8 :caption: Package Layout - xdoctest + auto/xdoctest Indices and tables diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/installing_python.rst new/xdoctest-1.1.6/docs/source/installing_python.rst --- old/xdoctest-1.1.5/docs/source/installing_python.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/installing_python.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,66 +0,0 @@ -Installing Python -================= - -Before you can use xdoctest, you must have Python installed. Its also best -practice to be in a `virtual environment <https://realpython.com/effective-python-environment/>`_. -If you are a Python beginner, then I would recommend setting up a -`conda <https://docs.conda.io/en/latest/>`_ environment. - - -On Linux, I typically use this end-to-end script for installing conda, -creating, and activating a virtual environment. - -.. code-block:: bash - - # Download the conda install script into a temporary directory - mkdir -p ~/tmp - cd ~/tmp - - # To update to a newer version see: - # https://docs.conda.io/en/latest/miniconda_hashes.html for updating - CONDA_INSTALL_SCRIPT=Miniconda3-py38_4.9.2-Linux-x86_64.sh - CONDA_EXPECTED_SHA256=1314b90489f154602fd794accfc90446111514a5a72fe1f71ab83e07de9504a7 - curl https://repo.anaconda.com/miniconda/$CONDA_INSTALL_SCRIPT > $CONDA_INSTALL_SCRIPT - CONDA_GOT_SHA256=$(sha256sum $CONDA_INSTALL_SCRIPT | cut -d' ' -f1) - # For security, it is important to verify the hash - if [[ "$CONDA_GOT_SHA256" != "$CONDA_EXPECTED_SHA256_HASH" ]]; then - echo "Downloaded file does not match hash! DO NOT CONTINUE!" - exit 1; - fi - chmod +x $CONDA_INSTALL_SCRIPT - - # Install miniconda to user local directory - _CONDA_ROOT=$HOME/.local/conda - sh $CONDA_INSTALL_SCRIPT -b -p $_CONDA_ROOT - # Activate the basic conda environment - source $_CONDA_ROOT/etc/profile.d/conda.sh - # Update the base and create a virtual environment named py38 - conda update --name base conda --yes - conda create --name py38 python=3.8 --yes - - # Activate your vitualenv - # I recommend doing something similar in your ~/.bashrc - source $_CONDA_ROOT/etc/profile.d/conda.sh - conda activate py38 - -Once you have created this conda environment, I recommend adding the following -lines to your ``.bashrc``. This way you will automatically activate your -virtual environment whenever you start a new bash shell. - -.. code-block:: bash - - # Enables the conda command - _CONDA_ROOT=$HOME/.local/conda - source $_CONDA_ROOT/etc/profile.d/conda.sh - - if [ -d "$HOME/.local/conda/envs/py38" ]; then - # Always start in a virtual environment - conda activate py38 - fi - - -For other operating systems, see the official documentation to install conda -`on Windows <https://docs.conda.io/projects/conda/en/latest/user-guide/install/windows.html>`_ or -`on MacOS <https://docs.conda.io/projects/conda/en/latest/user-guide/install/macos.html>`_. - -Once conda is installed the commands for `managing conda virtual environments <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#>`_ are roughly the same across platforms. diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/manual/installing_python.rst new/xdoctest-1.1.6/docs/source/manual/installing_python.rst --- old/xdoctest-1.1.5/docs/source/manual/installing_python.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/manual/installing_python.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,66 @@ +Installing Python +================= + +Before you can use xdoctest, you must have Python installed. Its also best +practice to be in a `virtual environment <https://realpython.com/effective-python-environment/>`_. +If you are a Python beginner, then I would recommend setting up a +`conda <https://docs.conda.io/en/latest/>`_ environment. + + +On Linux, I typically use this end-to-end script for installing conda, +creating, and activating a virtual environment. + +.. code-block:: bash + + # Download the conda install script into a temporary directory + mkdir -p ~/tmp + cd ~/tmp + + # To update to a newer version see: + # https://docs.conda.io/en/latest/miniconda_hashes.html for updating + CONDA_INSTALL_SCRIPT=Miniconda3-py38_4.9.2-Linux-x86_64.sh + CONDA_EXPECTED_SHA256=1314b90489f154602fd794accfc90446111514a5a72fe1f71ab83e07de9504a7 + curl https://repo.anaconda.com/miniconda/$CONDA_INSTALL_SCRIPT > $CONDA_INSTALL_SCRIPT + CONDA_GOT_SHA256=$(sha256sum $CONDA_INSTALL_SCRIPT | cut -d' ' -f1) + # For security, it is important to verify the hash + if [[ "$CONDA_GOT_SHA256" != "$CONDA_EXPECTED_SHA256_HASH" ]]; then + echo "Downloaded file does not match hash! DO NOT CONTINUE!" + exit 1; + fi + chmod +x $CONDA_INSTALL_SCRIPT + + # Install miniconda to user local directory + _CONDA_ROOT=$HOME/.local/conda + sh $CONDA_INSTALL_SCRIPT -b -p $_CONDA_ROOT + # Activate the basic conda environment + source $_CONDA_ROOT/etc/profile.d/conda.sh + # Update the base and create a virtual environment named py38 + conda update --name base conda --yes + conda create --name py38 python=3.8 --yes + + # Activate your vitualenv + # I recommend doing something similar in your ~/.bashrc + source $_CONDA_ROOT/etc/profile.d/conda.sh + conda activate py38 + +Once you have created this conda environment, I recommend adding the following +lines to your ``.bashrc``. This way you will automatically activate your +virtual environment whenever you start a new bash shell. + +.. code-block:: bash + + # Enables the conda command + _CONDA_ROOT=$HOME/.local/conda + source $_CONDA_ROOT/etc/profile.d/conda.sh + + if [ -d "$HOME/.local/conda/envs/py38" ]; then + # Always start in a virtual environment + conda activate py38 + fi + + +For other operating systems, see the official documentation to install conda +`on Windows <https://docs.conda.io/projects/conda/en/latest/user-guide/install/windows.html>`_ or +`on MacOS <https://docs.conda.io/projects/conda/en/latest/user-guide/install/macos.html>`_. + +Once conda is installed the commands for `managing conda virtual environments <https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html#>`_ are roughly the same across platforms. diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/manual/xdoc_with_jupyter.rst new/xdoctest-1.1.6/docs/source/manual/xdoc_with_jupyter.rst --- old/xdoctest-1.1.5/docs/source/manual/xdoc_with_jupyter.rst 1970-01-01 01:00:00.000000000 +0100 +++ new/xdoctest-1.1.6/docs/source/manual/xdoc_with_jupyter.rst 2024-08-01 19:21:41.000000000 +0200 @@ -0,0 +1,61 @@ +Running Doctests in Jupyter Notebooks +------------------------------------- + +You can run doctests within a Jupyter notebook in two ways: + +Method 1 - Inside the notebook +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Either insert this cell into your notebook: + +.. code:: python + + if __name__ == '__main__': + import xdoctest + xdoctest.doctest_module() + +This will execute any doctests for callables that are in the top-level +namespace of the notebook. While you don’t have to include the +``if __name__`` block, it is better practice because it will prevent +issues if you also wish to use “Method 2”. + +Method 2 - Outside the notebook +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +An alternative way to run would be using the xdoctest command line tool +and pointing to the notebook file. + +.. code:: bash + + xdoctest path/to/notebook.ipynb + +This will execute *every* cell in the notebook and then execute the +doctest of any defined callable with a doctest. + +Caveats +~~~~~~~ + +WARNING: in both of the above methods, when you execute doctests it will +include any function / class that was defined in the notebook, but also +*any external library callable with a doctest that you import directly*! +Therefore it is best to (1) never use ``from <module> import *`` +statements (in general using ``import *`` is bad practice) and (2) +prefer using functions via their module name rather than importing +directory. For example instead of +``from numpy import array; x = array([1])`` use +``import numpy as np; x = np.array([1])``. + +Lastly, it is important to note that Jupyter notebooks are great for +prototyping and exploration, but in practice storing algorithm and +utilities in Jupyter notebooks is not sustainable (`for some of these +reasons`_). Reusable code should eventually be refactored into a `proper +pip-installable Python package`_ where the top level directory contains +a ``setup.py`` and a folder with a name corresponding to the module name +and containing an ``__init__.py`` file and any other package python +files. However, if you write you original Jupyter code with doctests, +then when you port your code to a proper package the automated tests +come with it! (And the above warning does *not* apply to statically +parsed python packages) + +.. _for some of these reasons: https://github.com/grst/nbimporter#update-2019-06-i-do-not-recommend-any-mor... +.. _proper pip-installable Python package: https://packaging.python.org/tutorials/packaging-projects/ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/modules.rst new/xdoctest-1.1.6/docs/source/modules.rst --- old/xdoctest-1.1.5/docs/source/modules.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/modules.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest -======== - -.. toctree:: - :maxdepth: 4 - - xdoctest diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoc_with_jupyter.rst new/xdoctest-1.1.6/docs/source/xdoc_with_jupyter.rst --- old/xdoctest-1.1.5/docs/source/xdoc_with_jupyter.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoc_with_jupyter.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,61 +0,0 @@ -Running Doctests in Jupyter Notebooks -------------------------------------- - -You can run doctests within a Jupyter notebook in two ways: - -Method 1 - Inside the notebook -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Either insert this cell into your notebook: - -.. code:: python - - if __name__ == '__main__': - import xdoctest - xdoctest.doctest_module() - -This will execute any doctests for callables that are in the top-level -namespace of the notebook. While you don’t have to include the -``if __name__`` block, it is better practice because it will prevent -issues if you also wish to use “Method 2”. - -Method 2 - Outside the notebook -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -An alternative way to run would be using the xdoctest command line tool -and pointing to the notebook file. - -.. code:: bash - - xdoctest path/to/notebook.ipynb - -This will execute *every* cell in the notebook and then execute the -doctest of any defined callable with a doctest. - -Caveats -~~~~~~~ - -WARNING: in both of the above methods, when you execute doctests it will -include any function / class that was defined in the notebook, but also -*any external library callable with a doctest that you import directly*! -Therefore it is best to (1) never use ``from <module> import *`` -statements (in general using ``import *`` is bad practice) and (2) -prefer using functions via their module name rather than importing -directory. For example instead of -``from numpy import array; x = array([1])`` use -``import numpy as np; x = np.array([1])``. - -Lastly, it is important to note that Jupyter notebooks are great for -prototyping and exploration, but in practice storing algorithm and -utilities in Jupyter notebooks is not sustainable (`for some of these -reasons`_). Reusable code should eventually be refactored into a `proper -pip-installable Python package`_ where the top level directory contains -a ``setup.py`` and a folder with a name corresponding to the module name -and containing an ``__init__.py`` file and any other package python -files. However, if you write you original Jupyter code with doctests, -then when you port your code to a proper package the automated tests -come with it! (And the above warning does *not* apply to statically -parsed python packages) - -.. _for some of these reasons: https://github.com/grst/nbimporter#update-2019-06-i-do-not-recommend-any-mor... -.. _proper pip-installable Python package: https://packaging.python.org/tutorials/packaging-projects/ diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.checker.rst new/xdoctest-1.1.6/docs/source/xdoctest.checker.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.checker.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.checker.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.checker module -======================= - -.. automodule:: xdoctest.checker - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.constants.rst new/xdoctest-1.1.6/docs/source/xdoctest.constants.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.constants.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.constants.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.constants module -========================= - -.. automodule:: xdoctest.constants - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.core.rst new/xdoctest-1.1.6/docs/source/xdoctest.core.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.core.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.core.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.core module -==================== - -.. automodule:: xdoctest.core - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.demo.rst new/xdoctest-1.1.6/docs/source/xdoctest.demo.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.demo.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.demo.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.demo module -==================== - -.. automodule:: xdoctest.demo - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.directive.rst new/xdoctest-1.1.6/docs/source/xdoctest.directive.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.directive.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.directive.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.directive module -========================= - -.. automodule:: xdoctest.directive - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.docstr.docscrape_google.rst new/xdoctest-1.1.6/docs/source/xdoctest.docstr.docscrape_google.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.docstr.docscrape_google.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.docstr.docscrape_google.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.docstr.docscrape\_google module -======================================== - -.. automodule:: xdoctest.docstr.docscrape_google - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.docstr.docscrape_numpy.rst new/xdoctest-1.1.6/docs/source/xdoctest.docstr.docscrape_numpy.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.docstr.docscrape_numpy.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.docstr.docscrape_numpy.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.docstr.docscrape\_numpy module -======================================= - -.. automodule:: xdoctest.docstr.docscrape_numpy - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.docstr.rst new/xdoctest-1.1.6/docs/source/xdoctest.docstr.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.docstr.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.docstr.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,19 +0,0 @@ -xdoctest.docstr package -======================= - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - xdoctest.docstr.docscrape_google - xdoctest.docstr.docscrape_numpy - -Module contents ---------------- - -.. automodule:: xdoctest.docstr - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.doctest_example.rst new/xdoctest-1.1.6/docs/source/xdoctest.doctest_example.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.doctest_example.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.doctest_example.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.doctest\_example module -================================ - -.. automodule:: xdoctest.doctest_example - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.doctest_part.rst new/xdoctest-1.1.6/docs/source/xdoctest.doctest_part.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.doctest_part.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.doctest_part.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.doctest\_part module -============================= - -.. automodule:: xdoctest.doctest_part - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.dynamic_analysis.rst new/xdoctest-1.1.6/docs/source/xdoctest.dynamic_analysis.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.dynamic_analysis.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.dynamic_analysis.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.dynamic\_analysis module -================================= - -.. automodule:: xdoctest.dynamic_analysis - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.exceptions.rst new/xdoctest-1.1.6/docs/source/xdoctest.exceptions.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.exceptions.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.exceptions.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.exceptions module -========================== - -.. automodule:: xdoctest.exceptions - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.global_state.rst new/xdoctest-1.1.6/docs/source/xdoctest.global_state.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.global_state.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.global_state.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.global\_state module -============================= - -.. automodule:: xdoctest.global_state - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.parser.rst new/xdoctest-1.1.6/docs/source/xdoctest.parser.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.parser.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.parser.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.parser module -====================== - -.. automodule:: xdoctest.parser - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.plugin.rst new/xdoctest-1.1.6/docs/source/xdoctest.plugin.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.plugin.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.plugin.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.plugin module -====================== - -.. automodule:: xdoctest.plugin - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.rst new/xdoctest-1.1.6/docs/source/xdoctest.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,40 +0,0 @@ -xdoctest package -================ - -Subpackages ------------ - -.. toctree:: - :maxdepth: 4 - - xdoctest.docstr - xdoctest.utils - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - xdoctest.checker - xdoctest.constants - xdoctest.core - xdoctest.demo - xdoctest.directive - xdoctest.doctest_example - xdoctest.doctest_part - xdoctest.dynamic_analysis - xdoctest.exceptions - xdoctest.global_state - xdoctest.parser - xdoctest.plugin - xdoctest.runner - xdoctest.static_analysis - -Module contents ---------------- - -.. automodule:: xdoctest - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.runner.rst new/xdoctest-1.1.6/docs/source/xdoctest.runner.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.runner.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.runner.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.runner module -====================== - -.. automodule:: xdoctest.runner - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.static_analysis.rst new/xdoctest-1.1.6/docs/source/xdoctest.static_analysis.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.static_analysis.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.static_analysis.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.static\_analysis module -================================ - -.. automodule:: xdoctest.static_analysis - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.utils.rst new/xdoctest-1.1.6/docs/source/xdoctest.utils.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.utils.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.utils.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,25 +0,0 @@ -xdoctest.utils package -====================== - -Submodules ----------- - -.. toctree:: - :maxdepth: 4 - - xdoctest.utils.util_deprecation - xdoctest.utils.util_import - xdoctest.utils.util_misc - xdoctest.utils.util_mixins - xdoctest.utils.util_notebook - xdoctest.utils.util_path - xdoctest.utils.util_str - xdoctest.utils.util_stream - -Module contents ---------------- - -.. automodule:: xdoctest.utils - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_deprecation.rst new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_deprecation.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_deprecation.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_deprecation.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.utils.util\_deprecation module -======================================= - -.. automodule:: xdoctest.utils.util_deprecation - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_import.rst new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_import.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_import.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_import.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.utils.util\_import module -================================== - -.. automodule:: xdoctest.utils.util_import - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_misc.rst new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_misc.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_misc.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_misc.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.utils.util\_misc module -================================ - -.. automodule:: xdoctest.utils.util_misc - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_mixins.rst new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_mixins.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_mixins.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_mixins.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.utils.util\_mixins module -================================== - -.. automodule:: xdoctest.utils.util_mixins - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_notebook.rst new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_notebook.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_notebook.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_notebook.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.utils.util\_notebook module -==================================== - -.. automodule:: xdoctest.utils.util_notebook - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_path.rst new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_path.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_path.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_path.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.utils.util\_path module -================================ - -.. automodule:: xdoctest.utils.util_path - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_str.rst new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_str.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_str.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_str.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.utils.util\_str module -=============================== - -.. automodule:: xdoctest.utils.util_str - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_stream.rst new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_stream.rst --- old/xdoctest-1.1.5/docs/source/xdoctest.utils.util_stream.rst 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/docs/source/xdoctest.utils.util_stream.rst 1970-01-01 01:00:00.000000000 +0100 @@ -1,7 +0,0 @@ -xdoctest.utils.util\_stream module -================================== - -.. automodule:: xdoctest.utils.util_stream - :members: - :undoc-members: - :show-inheritance: diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/src/xdoctest/__init__.py new/xdoctest-1.1.6/src/xdoctest/__init__.py --- old/xdoctest-1.1.5/src/xdoctest/__init__.py 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/src/xdoctest/__init__.py 2024-08-01 19:21:41.000000000 +0200 @@ -1,8 +1,8 @@ # :github_url: https://github.com/Erotemic/xdoctest ''' -.. The large version wont work because github strips rst image rescaling. https://i.imgur.com/AcWVroL.png -.. image:: https://camo.githubusercontent.com/505298c88719d26f35794319bbc39a522e674314/... +.. The large version wont work because github strips rst image rescaling. https://i.imgur.com/u0tYYxM.png +.. image:: https://i.imgur.com/u0tYYxM.png :height: 100px :align: left @@ -56,8 +56,9 @@ Getting Started 0: Installation -------------------------------- -First ensure that you have :doc:`Python installed <../../installing_python>` and -ideally are in a virtual environment. Install xdoctest using the pip. +First ensure that you have +:doc:`Python installed <../manual/installing_python>` and ideally are in a +virtual environment. Install xdoctest using the pip. .. code:: bash @@ -94,7 +95,6 @@ a, b = b, a+b print() - We can add a "doctest" in the "docstring" as both an example and a test of the code. All we have to do is prefix the doctest code with three right chevrons `` >>> ``. We can also use xdoctest directives to control the flow of doctest @@ -127,10 +127,9 @@ ``xdoctest/__init__.py`` file, which is a Python file, that means we can write doctests in it. If you have xdoctest installed, you can use the xdoctest cli to execute the following code: ``xdoctest -m xdoctest.__init__ __doc__:0``. -Also notice that the previous code prefixed with ``>>> `` is skipped due to the -xdoctest ``SKIP`` :doc:`directive<xdoctest.directive>`. For more information on -directives see :doc:`the docs for the xdoctest directive -module<xdoctest.directive>`. +Also notice that the previous doctest is skipped due to the SKIP directive. +For more information on directives see +:doc:`the docs for the xdoctest directive module<auto/xdoctest.directive>`. .. code:: python @@ -305,7 +304,7 @@ You can also run doctests -:doc:`inside Jupyter Notebooks <../xdoc_with_jupyter>`. +:doc:`inside Jupyter Notebooks <../manual/xdoc_with_jupyter>`. ''' @@ -313,7 +312,7 @@ mkinit xdoctest --nomods ''' -__version__ = '1.1.5' +__version__ = '1.1.6' # Expose only select submodules diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/src/xdoctest/checker.py new/xdoctest-1.1.6/src/xdoctest/checker.py --- old/xdoctest-1.1.5/src/xdoctest/checker.py 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/src/xdoctest/checker.py 2024-08-01 19:21:41.000000000 +0200 @@ -14,21 +14,23 @@ A doctest that uses stdout might look like this ->>> print('We expect this exact string') -We expect this exact string +.. code:: python + + >>> print('We expect this exact string') + We expect this exact string A doctest that uses a raw expression might look like this ->>> def foo(): ->>> return 3 ->>> foo() -3 +.. code:: python + + >>> def foo(): + >>> return 3 + >>> foo() + 3 In most cases it is best to use stdout to write your got-want tests because it is easier to control strings sent to stdout than it is to control the representation of expression-based "got-strings". - - """ import re import difflib @@ -634,7 +636,7 @@ '\n{marker}', '{marker}']).format( marker=BLANKLINE_MARKER, pos_lb=pos_lb) # blankline_pattern = r'(?<=\n)[ ]*{}\n?'.format(re.escape(BLANKLINE_MARKER)) - new_text = re.sub(blankline_pattern, '\n', text, re.MULTILINE) + new_text = re.sub(blankline_pattern, '\n', text, flags=re.MULTILINE) return new_text diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/src/xdoctest/core.py new/xdoctest-1.1.6/src/xdoctest/core.py --- old/xdoctest-1.1.5/src/xdoctest/core.py 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/src/xdoctest/core.py 2024-08-01 19:21:41.000000000 +0200 @@ -5,29 +5,19 @@ The following is a glossary of terms and jargon used in this repo. -* callname - the name of a callable function, method, class etc... e.g. - ``myfunc``, ``MyClass``, or ``MyClass.some_method``. +* callname - the name of a callable function, method, class etc... e.g. ``myfunc``, ``MyClass``, or ``MyClass.some_method``. -* got / want - a test that produces stdout or a value to check. Whatever is - produced is what you "got" and whatever is expected is what you "want". - See :mod:`xdoctest.checker` for more details. - -* directives - special in-doctest comments that change the behavior of the - doctests at runtime. See :mod:`xdoctest.directive` for more details. - -* chevrons - the three cheverons (``>>> ``) or right angle brakets are the - standard prefix for a doctest, also referred to as a PS1 line in the - parser. +* got / want - a test that produces stdout or a value to check. Whatever is produced is what you "got" and whatever is expected is what you "want". See :mod:`xdoctest.checker` for more details. + +* directives - special in-doctest comments that change the behavior of the doctests at runtime. See :mod:`xdoctest.directive` for more details. + +* chevrons - the three cheverons (``>>> ``) or right angle brakets are the standard prefix for a doctest, also referred to as a PS1 line in the parser. * zero-args - a function that can be called without any arguments. -* freeform style - This is the term used to refer to a doctest that could be - anywhere in the docstring. The alternative are structured doctests where - they are only expected in known positions like in "Example blocks" for - google and numpy style docstrings. +* freeform style - This is the term used to refer to a doctest that could be anywhere in the docstring. The alternative are structured doctests where they are only expected in known positions like in "Example blocks" for google and numpy style docstrings. -* TODO - complete this list (Make an issue or PR if there is any term you don't - immediately understand!). +* TODO - complete this list (Make an issue or PR if there is any term you don't immediately understand!). """ import sys import textwrap diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn' '--exclude=.svnignore' old/xdoctest-1.1.5/src/xdoctest/doctest_example.py new/xdoctest-1.1.6/src/xdoctest/doctest_example.py --- old/xdoctest-1.1.5/src/xdoctest/doctest_example.py 2024-06-08 02:36:08.000000000 +0200 +++ new/xdoctest-1.1.6/src/xdoctest/doctest_example.py 2024-08-01 19:21:41.000000000 +0200 @@ -499,7 +499,7 @@ offset_linenos (bool): if True offset line numbers to agree with their position in the source text file (default False). - prefix (bool): if False, exclude the doctest `>>> ` prefix + prefix (bool): if False, exclude the doctest ``>>> `` prefix Returns: str