From: Scott Gasch Date: Wed, 12 Oct 2022 17:35:23 +0000 (-0700) Subject: Fixup sphinx doc generation so that it works post name change. X-Git-Url: https://wannabe.guru.org/gitweb/?a=commitdiff_plain;h=1c60a8d9ae5a162f8d309b48f8a07ee6946f3e25;p=pyutils.git Fixup sphinx doc generation so that it works post name change. --- diff --git a/cut_version.sh b/cut_version.sh index 0f477da..a3e5e13 100755 --- a/cut_version.sh +++ b/cut_version.sh @@ -58,7 +58,7 @@ echo echo "Ok, running scottutilz tests including test_some_dependencies.py..." cd ../scottutilz/tests ./run_tests.py --all --coverage -cd ../../pyutilz +cd ../../pyutils pause echo echo diff --git a/docs/pyutils.collectionz.rst b/docs/pyutils.collectionz.rst new file mode 100644 index 0000000..c342450 --- /dev/null +++ b/docs/pyutils.collectionz.rst @@ -0,0 +1,45 @@ +pyutils.collectionz package +=========================== + +Submodules +---------- + +pyutils.collectionz.bidict module +--------------------------------- + +.. automodule:: pyutils.collectionz.bidict + :members: + :undoc-members: + :show-inheritance: + +pyutils.collectionz.bst module +------------------------------ + +.. automodule:: pyutils.collectionz.bst + :members: + :undoc-members: + :show-inheritance: + +pyutils.collectionz.shared\_dict module +--------------------------------------- + +.. automodule:: pyutils.collectionz.shared_dict + :members: + :undoc-members: + :show-inheritance: + +pyutils.collectionz.trie module +------------------------------- + +.. automodule:: pyutils.collectionz.trie + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyutils.collectionz + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pyutils.compress.rst b/docs/pyutils.compress.rst new file mode 100644 index 0000000..e07a5e9 --- /dev/null +++ b/docs/pyutils.compress.rst @@ -0,0 +1,21 @@ +pyutils.compress package +======================== + +Submodules +---------- + +pyutils.compress.letter\_compress module +---------------------------------------- + +.. automodule:: pyutils.compress.letter_compress + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyutils.compress + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pyutils.datetimez.rst b/docs/pyutils.datetimez.rst new file mode 100644 index 0000000..167a22c --- /dev/null +++ b/docs/pyutils.datetimez.rst @@ -0,0 +1,61 @@ +pyutils.datetimez package +========================= + +Submodules +---------- + +pyutils.datetimez.constants module +---------------------------------- + +.. automodule:: pyutils.datetimez.constants + :members: + :undoc-members: + :show-inheritance: + +pyutils.datetimez.dateparse\_utils module +----------------------------------------- + +.. automodule:: pyutils.datetimez.dateparse_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.datetimez.dateparse\_utilsLexer module +---------------------------------------------- + +.. automodule:: pyutils.datetimez.dateparse_utilsLexer + :members: + :undoc-members: + :show-inheritance: + +pyutils.datetimez.dateparse\_utilsListener module +------------------------------------------------- + +.. automodule:: pyutils.datetimez.dateparse_utilsListener + :members: + :undoc-members: + :show-inheritance: + +pyutils.datetimez.dateparse\_utilsParser module +----------------------------------------------- + +.. automodule:: pyutils.datetimez.dateparse_utilsParser + :members: + :undoc-members: + :show-inheritance: + +pyutils.datetimez.datetime\_utils module +---------------------------------------- + +.. automodule:: pyutils.datetimez.datetime_utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyutils.datetimez + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pyutils.files.rst b/docs/pyutils.files.rst new file mode 100644 index 0000000..6878963 --- /dev/null +++ b/docs/pyutils.files.rst @@ -0,0 +1,37 @@ +pyutils.files package +===================== + +Submodules +---------- + +pyutils.files.directory\_filter module +-------------------------------------- + +.. automodule:: pyutils.files.directory_filter + :members: + :undoc-members: + :show-inheritance: + +pyutils.files.file\_utils module +-------------------------------- + +.. automodule:: pyutils.files.file_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.files.lockfile module +----------------------------- + +.. automodule:: pyutils.files.lockfile + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyutils.files + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pyutils.parallelize.rst b/docs/pyutils.parallelize.rst new file mode 100644 index 0000000..c53882d --- /dev/null +++ b/docs/pyutils.parallelize.rst @@ -0,0 +1,53 @@ +pyutils.parallelize package +=========================== + +Submodules +---------- + +pyutils.parallelize.deferred\_operand module +-------------------------------------------- + +.. automodule:: pyutils.parallelize.deferred_operand + :members: + :undoc-members: + :show-inheritance: + +pyutils.parallelize.executors module +------------------------------------ + +.. automodule:: pyutils.parallelize.executors + :members: + :undoc-members: + :show-inheritance: + +pyutils.parallelize.parallelize module +-------------------------------------- + +.. automodule:: pyutils.parallelize.parallelize + :members: + :undoc-members: + :show-inheritance: + +pyutils.parallelize.smart\_future module +---------------------------------------- + +.. automodule:: pyutils.parallelize.smart_future + :members: + :undoc-members: + :show-inheritance: + +pyutils.parallelize.thread\_utils module +---------------------------------------- + +.. automodule:: pyutils.parallelize.thread_utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyutils.parallelize + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pyutils.rst b/docs/pyutils.rst new file mode 100644 index 0000000..d8ba243 --- /dev/null +++ b/docs/pyutils.rst @@ -0,0 +1,212 @@ +pyutils package +=============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + pyutils.collectionz + pyutils.compress + pyutils.datetimez + pyutils.files + pyutils.parallelize + pyutils.search + pyutils.security + pyutils.typez + +Submodules +---------- + +pyutils.ansi module +------------------- + +.. automodule:: pyutils.ansi + :members: + :undoc-members: + :show-inheritance: + +pyutils.argparse\_utils module +------------------------------ + +.. automodule:: pyutils.argparse_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.bootstrap module +------------------------ + +.. automodule:: pyutils.bootstrap + :members: + :undoc-members: + :show-inheritance: + +pyutils.config module +--------------------- + +.. automodule:: pyutils.config + :members: + :undoc-members: + :show-inheritance: + +pyutils.decorator\_utils module +------------------------------- + +.. automodule:: pyutils.decorator_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.dict\_utils module +-------------------------- + +.. automodule:: pyutils.dict_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.exec\_utils module +-------------------------- + +.. automodule:: pyutils.exec_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.function\_utils module +------------------------------ + +.. automodule:: pyutils.function_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.id\_generator module +---------------------------- + +.. automodule:: pyutils.id_generator + :members: + :undoc-members: + :show-inheritance: + +pyutils.iter\_utils module +-------------------------- + +.. automodule:: pyutils.iter_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.list\_utils module +-------------------------- + +.. automodule:: pyutils.list_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.logging\_utils module +----------------------------- + +.. automodule:: pyutils.logging_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.math\_utils module +-------------------------- + +.. automodule:: pyutils.math_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.misc\_utils module +-------------------------- + +.. automodule:: pyutils.misc_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.persistent module +------------------------- + +.. automodule:: pyutils.persistent + :members: + :undoc-members: + :show-inheritance: + +pyutils.remote\_worker module +----------------------------- + +.. automodule:: pyutils.remote_worker + :members: + :undoc-members: + :show-inheritance: + +pyutils.state\_tracker module +----------------------------- + +.. automodule:: pyutils.state_tracker + :members: + :undoc-members: + :show-inheritance: + +pyutils.stopwatch module +------------------------ + +.. automodule:: pyutils.stopwatch + :members: + :undoc-members: + :show-inheritance: + +pyutils.string\_utils module +---------------------------- + +.. automodule:: pyutils.string_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.text\_utils module +-------------------------- + +.. automodule:: pyutils.text_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.unittest\_utils module +------------------------------ + +.. automodule:: pyutils.unittest_utils + :members: + :undoc-members: + :show-inheritance: + +pyutils.unscrambler module +-------------------------- + +.. automodule:: pyutils.unscrambler + :members: + :undoc-members: + :show-inheritance: + +pyutils.zookeeper module +------------------------ + +.. automodule:: pyutils.zookeeper + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyutils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pyutils.search.rst b/docs/pyutils.search.rst new file mode 100644 index 0000000..cea49bd --- /dev/null +++ b/docs/pyutils.search.rst @@ -0,0 +1,21 @@ +pyutils.search package +====================== + +Submodules +---------- + +pyutils.search.logical\_search module +------------------------------------- + +.. automodule:: pyutils.search.logical_search + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyutils.search + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pyutils.security.rst b/docs/pyutils.security.rst new file mode 100644 index 0000000..ba0a518 --- /dev/null +++ b/docs/pyutils.security.rst @@ -0,0 +1,21 @@ +pyutils.security package +======================== + +Submodules +---------- + +pyutils.security.acl module +--------------------------- + +.. automodule:: pyutils.security.acl + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyutils.security + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/pyutils.typez.rst b/docs/pyutils.typez.rst new file mode 100644 index 0000000..f96b7e2 --- /dev/null +++ b/docs/pyutils.typez.rst @@ -0,0 +1,53 @@ +pyutils.typez package +===================== + +Submodules +---------- + +pyutils.typez.centcount module +------------------------------ + +.. automodule:: pyutils.typez.centcount + :members: + :undoc-members: + :show-inheritance: + +pyutils.typez.histogram module +------------------------------ + +.. automodule:: pyutils.typez.histogram + :members: + :undoc-members: + :show-inheritance: + +pyutils.typez.money module +-------------------------- + +.. automodule:: pyutils.typez.money + :members: + :undoc-members: + :show-inheritance: + +pyutils.typez.rate module +------------------------- + +.. automodule:: pyutils.typez.rate + :members: + :undoc-members: + :show-inheritance: + +pyutils.typez.type\_utils module +-------------------------------- + +.. automodule:: pyutils.typez.type_utils + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: pyutils.typez + :members: + :undoc-members: + :show-inheritance: