diff --git a/README.md b/README.md index 37e12d2..6c314ed 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ pf.show_util_func_by_category() pf.show_util_func_by_keyword() # show all available functions by keyword in func_name -pf.find_func_by_keyword("show") +pf.find_util_func_by_keyword("show") ``` diff --git a/docs/source/reference/api/pyufunc.add_dir_to_env.rst b/docs/source/reference/api/pyufunc.add_dir_to_env.rst index 3fc2a0d..2bfd083 100644 --- a/docs/source/reference/api/pyufunc.add_dir_to_env.rst +++ b/docs/source/reference/api/pyufunc.add_dir_to_env.rst @@ -1,5 +1,5 @@ -pyufunc.adddir\_to\_env -======================= +pyufunc.add\_dir\_to\_env +========================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.calc_distance_on_unit_sphere.rst b/docs/source/reference/api/pyufunc.calc_distance_on_unit_sphere.rst index f2d0098..e4397f7 100644 --- a/docs/source/reference/api/pyufunc.calc_distance_on_unit_sphere.rst +++ b/docs/source/reference/api/pyufunc.calc_distance_on_unit_sphere.rst @@ -1,5 +1,5 @@ -pyufunc.calcdistance\_on\_unit\_sphere -====================================== +pyufunc.calc\_distance\_on\_unit\_sphere +======================================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.check_filename.rst b/docs/source/reference/api/pyufunc.check_filename.rst index aa54adc..951694f 100644 --- a/docs/source/reference/api/pyufunc.check_filename.rst +++ b/docs/source/reference/api/pyufunc.check_filename.rst @@ -1,5 +1,5 @@ -pyufunc.checkfilename -===================== +pyufunc.check\_filename +======================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.check_files_existence.rst b/docs/source/reference/api/pyufunc.check_files_existence.rst index 8a3fd95..c832abf 100644 --- a/docs/source/reference/api/pyufunc.check_files_existence.rst +++ b/docs/source/reference/api/pyufunc.check_files_existence.rst @@ -1,5 +1,5 @@ -pyufunc.checkfiles\_existence -============================= +pyufunc.check\_files\_existence +=============================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.check_platform.rst b/docs/source/reference/api/pyufunc.check_platform.rst index f0f8601..d93721d 100644 --- a/docs/source/reference/api/pyufunc.check_platform.rst +++ b/docs/source/reference/api/pyufunc.check_platform.rst @@ -1,5 +1,5 @@ -pyufunc.checkplatform -===================== +pyufunc.check\_platform +======================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.create_circle_at_point_with_radius.rst b/docs/source/reference/api/pyufunc.create_circle_at_point_with_radius.rst index 3121b7f..eb1d1b0 100644 --- a/docs/source/reference/api/pyufunc.create_circle_at_point_with_radius.rst +++ b/docs/source/reference/api/pyufunc.create_circle_at_point_with_radius.rst @@ -1,5 +1,5 @@ -pyufunc.createcircle\_at\_point\_with\_radius -============================================= +pyufunc.create\_circle\_at\_point\_with\_radius +=============================================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.create_tempfile.rst b/docs/source/reference/api/pyufunc.create_tempfile.rst index 413be54..d5ceba9 100644 --- a/docs/source/reference/api/pyufunc.create_tempfile.rst +++ b/docs/source/reference/api/pyufunc.create_tempfile.rst @@ -1,5 +1,5 @@ -pyufunc.createtempfile -====================== +pyufunc.create\_tempfile +======================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.cvt_PIL_img_to_bytes.rst b/docs/source/reference/api/pyufunc.cvt_PIL_img_to_bytes.rst index a8a9d32..efa2331 100644 --- a/docs/source/reference/api/pyufunc.cvt_PIL_img_to_bytes.rst +++ b/docs/source/reference/api/pyufunc.cvt_PIL_img_to_bytes.rst @@ -1,5 +1,5 @@ -pyufunc.cvtPIL\_img\_to\_bytes -============================== +pyufunc.cvt\_PIL\_img\_to\_bytes +================================ .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.cvt_dt_to_tz.rst b/docs/source/reference/api/pyufunc.cvt_dt_to_tz.rst index 816d126..b9ae38a 100644 --- a/docs/source/reference/api/pyufunc.cvt_dt_to_tz.rst +++ b/docs/source/reference/api/pyufunc.cvt_dt_to_tz.rst @@ -1,5 +1,5 @@ -pyufunc.cvtdt\_to\_tz -===================== +pyufunc.cvt\_dt\_to\_tz +======================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.cvt_img_CV_to_PIL.rst b/docs/source/reference/api/pyufunc.cvt_img_CV_to_PIL.rst index 01b5fb4..a8566d6 100644 --- a/docs/source/reference/api/pyufunc.cvt_img_CV_to_PIL.rst +++ b/docs/source/reference/api/pyufunc.cvt_img_CV_to_PIL.rst @@ -1,5 +1,5 @@ -pyufunc.cvtimg\_CV\_to\_PIL -=========================== +pyufunc.cvt\_img\_CV\_to\_PIL +============================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.cvt_img_PIL_to_CV.rst b/docs/source/reference/api/pyufunc.cvt_img_PIL_to_CV.rst index 03d0c70..ef14f36 100644 --- a/docs/source/reference/api/pyufunc.cvt_img_PIL_to_CV.rst +++ b/docs/source/reference/api/pyufunc.cvt_img_PIL_to_CV.rst @@ -1,5 +1,5 @@ -pyufunc.cvtimg\_PIL\_to\_CV -=========================== +pyufunc.cvt\_img\_PIL\_to\_CV +============================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.cvt_img_bytes_to_PIL_img.rst b/docs/source/reference/api/pyufunc.cvt_img_bytes_to_PIL_img.rst index fb588d8..6827450 100644 --- a/docs/source/reference/api/pyufunc.cvt_img_bytes_to_PIL_img.rst +++ b/docs/source/reference/api/pyufunc.cvt_img_bytes_to_PIL_img.rst @@ -1,5 +1,5 @@ -pyufunc.cvtimg\_bytes\_to\_PIL\_img -=================================== +pyufunc.cvt\_img\_bytes\_to\_PIL\_img +===================================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.cvt_img_to_bytes.rst b/docs/source/reference/api/pyufunc.cvt_img_to_bytes.rst index 88002d4..6e2ffe8 100644 --- a/docs/source/reference/api/pyufunc.cvt_img_to_bytes.rst +++ b/docs/source/reference/api/pyufunc.cvt_img_to_bytes.rst @@ -1,5 +1,5 @@ -pyufunc.cvtimg\_to\_bytes -========================= +pyufunc.cvt\_img\_to\_bytes +=========================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.cvt_int_to_alpha.rst b/docs/source/reference/api/pyufunc.cvt_int_to_alpha.rst index f23f927..024c637 100644 --- a/docs/source/reference/api/pyufunc.cvt_int_to_alpha.rst +++ b/docs/source/reference/api/pyufunc.cvt_int_to_alpha.rst @@ -1,5 +1,5 @@ -pyufunc.cvtint\_to\_alpha -========================= +pyufunc.cvt\_int\_to\_alpha +=========================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.find_closest_point.rst b/docs/source/reference/api/pyufunc.find_closest_point.rst index 66abd2b..cf61190 100644 --- a/docs/source/reference/api/pyufunc.find_closest_point.rst +++ b/docs/source/reference/api/pyufunc.find_closest_point.rst @@ -1,5 +1,5 @@ -pyufunc.findclosest\_point -========================== +pyufunc.find\_closest\_point +============================ .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.find_func_by_keyword.rst b/docs/source/reference/api/pyufunc.find_func_by_keyword.rst deleted file mode 100644 index b366417..0000000 --- a/docs/source/reference/api/pyufunc.find_func_by_keyword.rst +++ /dev/null @@ -1,7 +0,0 @@ -pyufunc.findfunc\_by\_keyword -============================= - -.. automodule:: pyufunc - -.. autofunction:: find_func_by_keyword - diff --git a/docs/source/reference/api/pyufunc.find_k_nearest_points.rst b/docs/source/reference/api/pyufunc.find_k_nearest_points.rst index 8480406..14c197b 100644 --- a/docs/source/reference/api/pyufunc.find_k_nearest_points.rst +++ b/docs/source/reference/api/pyufunc.find_k_nearest_points.rst @@ -1,5 +1,5 @@ -pyufunc.findk\_nearest\_points -============================== +pyufunc.find\_k\_nearest\_points +================================ .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.find_util_func_by_keyword.rst b/docs/source/reference/api/pyufunc.find_util_func_by_keyword.rst new file mode 100644 index 0000000..d582960 --- /dev/null +++ b/docs/source/reference/api/pyufunc.find_util_func_by_keyword.rst @@ -0,0 +1,7 @@ +pyufunc.find\_util\_func\_by\_keyword +===================================== + +.. automodule:: pyufunc + +.. autofunction:: find_util_func_by_keyword + diff --git a/docs/source/reference/api/pyufunc.fmt_dt_to_str.rst b/docs/source/reference/api/pyufunc.fmt_dt_to_str.rst index 3f70941..1f99167 100644 --- a/docs/source/reference/api/pyufunc.fmt_dt_to_str.rst +++ b/docs/source/reference/api/pyufunc.fmt_dt_to_str.rst @@ -1,5 +1,5 @@ -pyufunc.fmtdt\_to\_str -====================== +pyufunc.fmt\_dt\_to\_str +======================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.func_running_time.rst b/docs/source/reference/api/pyufunc.func_running_time.rst index d5d0a48..cafca19 100644 --- a/docs/source/reference/api/pyufunc.func_running_time.rst +++ b/docs/source/reference/api/pyufunc.func_running_time.rst @@ -1,5 +1,5 @@ -pyufunc.funcrunning\_time -========================= +pyufunc.func\_running\_time +=========================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.func_time.rst b/docs/source/reference/api/pyufunc.func_time.rst index 8d5d713..576e725 100644 --- a/docs/source/reference/api/pyufunc.func_time.rst +++ b/docs/source/reference/api/pyufunc.func_time.rst @@ -1,5 +1,5 @@ -pyufunc.functime -================ +pyufunc.func\_time +================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.generate_password.rst b/docs/source/reference/api/pyufunc.generate_password.rst index 4ad0715..0a02033 100644 --- a/docs/source/reference/api/pyufunc.generate_password.rst +++ b/docs/source/reference/api/pyufunc.generate_password.rst @@ -1,5 +1,5 @@ -pyufunc.generatepassword -======================== +pyufunc.generate\_password +========================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.generate_unique_filename.rst b/docs/source/reference/api/pyufunc.generate_unique_filename.rst index 885f26a..1529202 100644 --- a/docs/source/reference/api/pyufunc.generate_unique_filename.rst +++ b/docs/source/reference/api/pyufunc.generate_unique_filename.rst @@ -1,5 +1,5 @@ -pyufunc.generateunique\_filename -================================ +pyufunc.generate\_unique\_filename +================================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.get_coordinates_from_geom.rst b/docs/source/reference/api/pyufunc.get_coordinates_from_geom.rst index 5050d70..5f64b37 100644 --- a/docs/source/reference/api/pyufunc.get_coordinates_from_geom.rst +++ b/docs/source/reference/api/pyufunc.get_coordinates_from_geom.rst @@ -1,5 +1,5 @@ -pyufunc.getcoordinates\_from\_geom -================================== +pyufunc.get\_coordinates\_from\_geom +==================================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.get_dir_size.rst b/docs/source/reference/api/pyufunc.get_dir_size.rst index 3a892cb..660d475 100644 --- a/docs/source/reference/api/pyufunc.get_dir_size.rst +++ b/docs/source/reference/api/pyufunc.get_dir_size.rst @@ -1,5 +1,5 @@ -pyufunc.getdir\_size -==================== +pyufunc.get\_dir\_size +====================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.get_file_size.rst b/docs/source/reference/api/pyufunc.get_file_size.rst index c44dc92..45f65d6 100644 --- a/docs/source/reference/api/pyufunc.get_file_size.rst +++ b/docs/source/reference/api/pyufunc.get_file_size.rst @@ -1,5 +1,5 @@ -pyufunc.getfile\_size -===================== +pyufunc.get\_file\_size +======================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.get_filenames_by_ext.rst b/docs/source/reference/api/pyufunc.get_filenames_by_ext.rst index ba2ef37..48e18d5 100644 --- a/docs/source/reference/api/pyufunc.get_filenames_by_ext.rst +++ b/docs/source/reference/api/pyufunc.get_filenames_by_ext.rst @@ -1,5 +1,5 @@ -pyufunc.getfilenames\_by\_ext -============================= +pyufunc.get\_filenames\_by\_ext +=============================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.get_host_ip.rst b/docs/source/reference/api/pyufunc.get_host_ip.rst index 3b07a09..becccb2 100644 --- a/docs/source/reference/api/pyufunc.get_host_ip.rst +++ b/docs/source/reference/api/pyufunc.get_host_ip.rst @@ -1,5 +1,5 @@ -pyufunc.gethost\_ip -=================== +pyufunc.get\_host\_ip +===================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.get_time_diff_in_unit.rst b/docs/source/reference/api/pyufunc.get_time_diff_in_unit.rst index 621ed18..0fc88c4 100644 --- a/docs/source/reference/api/pyufunc.get_time_diff_in_unit.rst +++ b/docs/source/reference/api/pyufunc.get_time_diff_in_unit.rst @@ -1,5 +1,5 @@ -pyufunc.gettime\_diff\_in\_unit -=============================== +pyufunc.get\_time\_diff\_in\_unit +================================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.get_timezone.rst b/docs/source/reference/api/pyufunc.get_timezone.rst index 170c147..f97926b 100644 --- a/docs/source/reference/api/pyufunc.get_timezone.rst +++ b/docs/source/reference/api/pyufunc.get_timezone.rst @@ -1,5 +1,5 @@ -pyufunc.gettimezone -=================== +pyufunc.get\_timezone +===================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.get_user_defined_func.rst b/docs/source/reference/api/pyufunc.get_user_defined_func.rst index bc8d069..922fd0c 100644 --- a/docs/source/reference/api/pyufunc.get_user_defined_func.rst +++ b/docs/source/reference/api/pyufunc.get_user_defined_func.rst @@ -1,5 +1,5 @@ -pyufunc.getuser\_defined\_func -============================== +pyufunc.get\_user\_defined\_func +================================ .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.github_file_downloader.rst b/docs/source/reference/api/pyufunc.github_file_downloader.rst index b2a59f6..228073c 100644 --- a/docs/source/reference/api/pyufunc.github_file_downloader.rst +++ b/docs/source/reference/api/pyufunc.github_file_downloader.rst @@ -1,5 +1,5 @@ -pyufunc.githubfile\_downloader -============================== +pyufunc.github\_file\_downloader +================================ .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.github_get_status.rst b/docs/source/reference/api/pyufunc.github_get_status.rst index 34e2ab3..4ee5b18 100644 --- a/docs/source/reference/api/pyufunc.github_get_status.rst +++ b/docs/source/reference/api/pyufunc.github_get_status.rst @@ -1,5 +1,5 @@ -pyufunc.githubget\_status -========================= +pyufunc.github\_get\_status +=========================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.gmns_geo.rst b/docs/source/reference/api/pyufunc.gmns_geo.rst index 9d82d54..3a595c3 100644 --- a/docs/source/reference/api/pyufunc.gmns_geo.rst +++ b/docs/source/reference/api/pyufunc.gmns_geo.rst @@ -1,5 +1,5 @@ -pyufunc.gmnsgeo -=============== +pyufunc.gmns\_geo +================= .. automodule:: pyufunc.gmns_geo diff --git a/docs/source/reference/api/pyufunc.group_dt_daily.rst b/docs/source/reference/api/pyufunc.group_dt_daily.rst index 99f4635..6db0229 100644 --- a/docs/source/reference/api/pyufunc.group_dt_daily.rst +++ b/docs/source/reference/api/pyufunc.group_dt_daily.rst @@ -1,5 +1,5 @@ -pyufunc.groupdt\_daily -====================== +pyufunc.group\_dt\_daily +======================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.group_dt_hourly.rst b/docs/source/reference/api/pyufunc.group_dt_hourly.rst index 4b3a249..a641905 100644 --- a/docs/source/reference/api/pyufunc.group_dt_hourly.rst +++ b/docs/source/reference/api/pyufunc.group_dt_hourly.rst @@ -1,5 +1,5 @@ -pyufunc.groupdt\_hourly -======================= +pyufunc.group\_dt\_hourly +========================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.group_dt_minutely.rst b/docs/source/reference/api/pyufunc.group_dt_minutely.rst index 9c7c166..8e71e0b 100644 --- a/docs/source/reference/api/pyufunc.group_dt_minutely.rst +++ b/docs/source/reference/api/pyufunc.group_dt_minutely.rst @@ -1,5 +1,5 @@ -pyufunc.groupdt\_minutely -========================= +pyufunc.group\_dt\_minutely +=========================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.group_dt_monthly.rst b/docs/source/reference/api/pyufunc.group_dt_monthly.rst index 3218fc1..bbd5730 100644 --- a/docs/source/reference/api/pyufunc.group_dt_monthly.rst +++ b/docs/source/reference/api/pyufunc.group_dt_monthly.rst @@ -1,5 +1,5 @@ -pyufunc.groupdt\_monthly -======================== +pyufunc.group\_dt\_monthly +========================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.group_dt_weekly.rst b/docs/source/reference/api/pyufunc.group_dt_weekly.rst index d722561..c91e5da 100644 --- a/docs/source/reference/api/pyufunc.group_dt_weekly.rst +++ b/docs/source/reference/api/pyufunc.group_dt_weekly.rst @@ -1,5 +1,5 @@ -pyufunc.groupdt\_weekly -======================= +pyufunc.group\_dt\_weekly +========================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.group_dt_yearly.rst b/docs/source/reference/api/pyufunc.group_dt_yearly.rst index a3d2199..9ece975 100644 --- a/docs/source/reference/api/pyufunc.group_dt_yearly.rst +++ b/docs/source/reference/api/pyufunc.group_dt_yearly.rst @@ -1,5 +1,5 @@ -pyufunc.groupdt\_yearly -======================= +pyufunc.group\_dt\_yearly +========================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.img_resize.rst b/docs/source/reference/api/pyufunc.img_resize.rst index 958e36b..e6caecb 100644 --- a/docs/source/reference/api/pyufunc.img_resize.rst +++ b/docs/source/reference/api/pyufunc.img_resize.rst @@ -1,5 +1,5 @@ -pyufunc.imgresize -================= +pyufunc.img\_resize +=================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.img_rotate.rst b/docs/source/reference/api/pyufunc.img_rotate.rst index ebed323..8a3f04a 100644 --- a/docs/source/reference/api/pyufunc.img_rotate.rst +++ b/docs/source/reference/api/pyufunc.img_rotate.rst @@ -1,5 +1,5 @@ -pyufunc.imgrotate -================= +pyufunc.img\_rotate +=================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.img_rotate_bound.rst b/docs/source/reference/api/pyufunc.img_rotate_bound.rst index f1b23fc..73bca61 100644 --- a/docs/source/reference/api/pyufunc.img_rotate_bound.rst +++ b/docs/source/reference/api/pyufunc.img_rotate_bound.rst @@ -1,5 +1,5 @@ -pyufunc.imgrotate\_bound -======================== +pyufunc.img\_rotate\_bound +========================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.img_show.rst b/docs/source/reference/api/pyufunc.img_show.rst index 31245f1..7993d55 100644 --- a/docs/source/reference/api/pyufunc.img_show.rst +++ b/docs/source/reference/api/pyufunc.img_show.rst @@ -1,5 +1,5 @@ -pyufunc.imgshow -=============== +pyufunc.img\_show +================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.img_translate.rst b/docs/source/reference/api/pyufunc.img_translate.rst index 9cfbc38..40724c1 100644 --- a/docs/source/reference/api/pyufunc.img_translate.rst +++ b/docs/source/reference/api/pyufunc.img_translate.rst @@ -1,5 +1,5 @@ -pyufunc.imgtranslate -==================== +pyufunc.img\_translate +====================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.import_package.rst b/docs/source/reference/api/pyufunc.import_package.rst index 5a12d63..3f742eb 100644 --- a/docs/source/reference/api/pyufunc.import_package.rst +++ b/docs/source/reference/api/pyufunc.import_package.rst @@ -1,5 +1,5 @@ -pyufunc.importpackage -===================== +pyufunc.import\_package +======================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.is_CV_img.rst b/docs/source/reference/api/pyufunc.is_CV_img.rst index ba8a41d..fa437c6 100644 --- a/docs/source/reference/api/pyufunc.is_CV_img.rst +++ b/docs/source/reference/api/pyufunc.is_CV_img.rst @@ -1,5 +1,5 @@ -pyufunc.isCV\_img -================= +pyufunc.is\_CV\_img +=================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.is_PIL_img.rst b/docs/source/reference/api/pyufunc.is_PIL_img.rst index ca659ef..d2f6af4 100644 --- a/docs/source/reference/api/pyufunc.is_PIL_img.rst +++ b/docs/source/reference/api/pyufunc.is_PIL_img.rst @@ -1,5 +1,5 @@ -pyufunc.isPIL\_img -================== +pyufunc.is\_PIL\_img +==================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.is_linux.rst b/docs/source/reference/api/pyufunc.is_linux.rst index b2038e4..9f83629 100644 --- a/docs/source/reference/api/pyufunc.is_linux.rst +++ b/docs/source/reference/api/pyufunc.is_linux.rst @@ -1,5 +1,5 @@ -pyufunc.islinux -=============== +pyufunc.is\_linux +================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.is_mac.rst b/docs/source/reference/api/pyufunc.is_mac.rst index 6bb0795..80bf244 100644 --- a/docs/source/reference/api/pyufunc.is_mac.rst +++ b/docs/source/reference/api/pyufunc.is_mac.rst @@ -1,5 +1,5 @@ -pyufunc.ismac -============= +pyufunc.is\_mac +=============== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.is_module_importable.rst b/docs/source/reference/api/pyufunc.is_module_importable.rst index aaa8ad6..32a8f00 100644 --- a/docs/source/reference/api/pyufunc.is_module_importable.rst +++ b/docs/source/reference/api/pyufunc.is_module_importable.rst @@ -1,5 +1,5 @@ -pyufunc.ismodule\_importable -============================ +pyufunc.is\_module\_importable +============================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.is_user_defined_func.rst b/docs/source/reference/api/pyufunc.is_user_defined_func.rst index 182b59d..28b6b07 100644 --- a/docs/source/reference/api/pyufunc.is_user_defined_func.rst +++ b/docs/source/reference/api/pyufunc.is_user_defined_func.rst @@ -1,5 +1,5 @@ -pyufunc.isuser\_defined\_func -============================= +pyufunc.is\_user\_defined\_func +=============================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.is_valid_email.rst b/docs/source/reference/api/pyufunc.is_valid_email.rst index 8fa08e2..8940cb6 100644 --- a/docs/source/reference/api/pyufunc.is_valid_email.rst +++ b/docs/source/reference/api/pyufunc.is_valid_email.rst @@ -1,5 +1,5 @@ -pyufunc.isvalid\_email -====================== +pyufunc.is\_valid\_email +======================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.is_windows.rst b/docs/source/reference/api/pyufunc.is_windows.rst index 7a47a57..4c36c66 100644 --- a/docs/source/reference/api/pyufunc.is_windows.rst +++ b/docs/source/reference/api/pyufunc.is_windows.rst @@ -1,5 +1,5 @@ -pyufunc.iswindows -================= +pyufunc.is\_windows +=================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.list_all_timezones.rst b/docs/source/reference/api/pyufunc.list_all_timezones.rst index ff1e1cf..53210c4 100644 --- a/docs/source/reference/api/pyufunc.list_all_timezones.rst +++ b/docs/source/reference/api/pyufunc.list_all_timezones.rst @@ -1,5 +1,5 @@ -pyufunc.listall\_timezones -========================== +pyufunc.list\_all\_timezones +============================ .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.path2linux.rst b/docs/source/reference/api/pyufunc.path2linux.rst index 372bbd2..cb8b082 100644 --- a/docs/source/reference/api/pyufunc.path2linux.rst +++ b/docs/source/reference/api/pyufunc.path2linux.rst @@ -1,5 +1,5 @@ -pyufunc.path2lin -================ +pyufunc.path2linux +================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.path2uniform.rst b/docs/source/reference/api/pyufunc.path2uniform.rst index df7f484..9e830d1 100644 --- a/docs/source/reference/api/pyufunc.path2uniform.rst +++ b/docs/source/reference/api/pyufunc.path2uniform.rst @@ -1,5 +1,5 @@ -pyufunc.path2unifo -================== +pyufunc.path2uniform +==================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.proj_point_to_line.rst b/docs/source/reference/api/pyufunc.proj_point_to_line.rst index 3e899d0..c789446 100644 --- a/docs/source/reference/api/pyufunc.proj_point_to_line.rst +++ b/docs/source/reference/api/pyufunc.proj_point_to_line.rst @@ -1,5 +1,5 @@ -pyufunc.projpoint\_to\_line -=========================== +pyufunc.proj\_point\_to\_line +============================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.pypi_downloads.rst b/docs/source/reference/api/pyufunc.pypi_downloads.rst index 5658e27..807863f 100644 --- a/docs/source/reference/api/pyufunc.pypi_downloads.rst +++ b/docs/source/reference/api/pyufunc.pypi_downloads.rst @@ -1,5 +1,5 @@ -pyufunc.pypidownloads -===================== +pyufunc.pypi\_downloads +======================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.remove_file.rst b/docs/source/reference/api/pyufunc.remove_file.rst index 8373057..606f887 100644 --- a/docs/source/reference/api/pyufunc.remove_file.rst +++ b/docs/source/reference/api/pyufunc.remove_file.rst @@ -1,5 +1,5 @@ -pyufunc.removefile -================== +pyufunc.remove\_file +==================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.requires.rst b/docs/source/reference/api/pyufunc.requires.rst index 13838b3..bef6387 100644 --- a/docs/source/reference/api/pyufunc.requires.rst +++ b/docs/source/reference/api/pyufunc.requires.rst @@ -1,5 +1,5 @@ -pyufunc.requir -============== +pyufunc.requires +================ .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.run_parallel.rst b/docs/source/reference/api/pyufunc.run_parallel.rst index 71ce2f8..fe68c9a 100644 --- a/docs/source/reference/api/pyufunc.run_parallel.rst +++ b/docs/source/reference/api/pyufunc.run_parallel.rst @@ -1,5 +1,5 @@ -pyufunc.runparallel -=================== +pyufunc.run\_parallel +===================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.send_email.rst b/docs/source/reference/api/pyufunc.send_email.rst index 6c58e7a..96ca3a9 100644 --- a/docs/source/reference/api/pyufunc.send_email.rst +++ b/docs/source/reference/api/pyufunc.send_email.rst @@ -1,5 +1,5 @@ -pyufunc.sendemail -================= +pyufunc.send\_email +=================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.show_docstring_google.rst b/docs/source/reference/api/pyufunc.show_docstring_google.rst index ebe316a..0d2a18f 100644 --- a/docs/source/reference/api/pyufunc.show_docstring_google.rst +++ b/docs/source/reference/api/pyufunc.show_docstring_google.rst @@ -1,5 +1,5 @@ -pyufunc.showdocstring\_google -============================= +pyufunc.show\_docstring\_google +=============================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.show_docstring_headers.rst b/docs/source/reference/api/pyufunc.show_docstring_headers.rst index a4a7df4..49f7301 100644 --- a/docs/source/reference/api/pyufunc.show_docstring_headers.rst +++ b/docs/source/reference/api/pyufunc.show_docstring_headers.rst @@ -1,5 +1,5 @@ -pyufunc.showdocstring\_headers -============================== +pyufunc.show\_docstring\_headers +================================ .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.show_docstring_numpy.rst b/docs/source/reference/api/pyufunc.show_docstring_numpy.rst index db4ad91..d6b67ea 100644 --- a/docs/source/reference/api/pyufunc.show_docstring_numpy.rst +++ b/docs/source/reference/api/pyufunc.show_docstring_numpy.rst @@ -1,5 +1,5 @@ -pyufunc.showdocstring\_numpy -============================ +pyufunc.show\_docstring\_numpy +============================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.show_util_func_by_category.rst b/docs/source/reference/api/pyufunc.show_util_func_by_category.rst index 9064b5c..0242e87 100644 --- a/docs/source/reference/api/pyufunc.show_util_func_by_category.rst +++ b/docs/source/reference/api/pyufunc.show_util_func_by_category.rst @@ -1,5 +1,5 @@ -pyufunc.showutil\_func\_by\_category -==================================== +pyufunc.show\_util\_func\_by\_category +====================================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.show_util_func_by_keyword.rst b/docs/source/reference/api/pyufunc.show_util_func_by_keyword.rst index 12cfc39..5080dd0 100644 --- a/docs/source/reference/api/pyufunc.show_util_func_by_keyword.rst +++ b/docs/source/reference/api/pyufunc.show_util_func_by_keyword.rst @@ -1,5 +1,5 @@ -pyufunc.showutil\_func\_by\_keyword -=================================== +pyufunc.show\_util\_func\_by\_keyword +===================================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.split_dict_by_chunk.rst b/docs/source/reference/api/pyufunc.split_dict_by_chunk.rst index ace068d..ce4404a 100644 --- a/docs/source/reference/api/pyufunc.split_dict_by_chunk.rst +++ b/docs/source/reference/api/pyufunc.split_dict_by_chunk.rst @@ -1,5 +1,5 @@ -pyufunc.splitdict\_by\_chunk -============================ +pyufunc.split\_dict\_by\_chunk +============================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.split_list_by_equal_sublist.rst b/docs/source/reference/api/pyufunc.split_list_by_equal_sublist.rst index 695491e..9237da0 100644 --- a/docs/source/reference/api/pyufunc.split_list_by_equal_sublist.rst +++ b/docs/source/reference/api/pyufunc.split_list_by_equal_sublist.rst @@ -1,5 +1,5 @@ -pyufunc.splitlist\_by\_equal\_sublist -===================================== +pyufunc.split\_list\_by\_equal\_sublist +======================================= .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.split_list_by_fixed_length.rst b/docs/source/reference/api/pyufunc.split_list_by_fixed_length.rst index 98c516d..49919fc 100644 --- a/docs/source/reference/api/pyufunc.split_list_by_fixed_length.rst +++ b/docs/source/reference/api/pyufunc.split_list_by_fixed_length.rst @@ -1,5 +1,5 @@ -pyufunc.splitlist\_by\_fixed\_length -==================================== +pyufunc.split\_list\_by\_fixed\_length +====================================== .. automodule:: pyufunc diff --git a/docs/source/reference/api/pyufunc.validate_url.rst b/docs/source/reference/api/pyufunc.validate_url.rst index 8243fa5..4630294 100644 --- a/docs/source/reference/api/pyufunc.validate_url.rst +++ b/docs/source/reference/api/pyufunc.validate_url.rst @@ -1,5 +1,5 @@ -pyufunc.validateurl -=================== +pyufunc.validate\_url +===================== .. automodule:: pyufunc diff --git a/docs/source/reference/create_api.py b/docs/source/reference/create_api.py index 8bf426a..653472b 100644 --- a/docs/source/reference/create_api.py +++ b/docs/source/reference/create_api.py @@ -31,15 +31,11 @@ for module in category_lst: file_name = f"api/pyufunc.{module}.rst" - with open(file_name, "w", encoding="utf-8") as f: - heading_message = "pyufunc." + module + heading_message = "pyufunc." + module - heading_message_split = heading_message.split("_") - heading_message_new = heading_message_split[0] - for i in range(1, len(heading_message_split)): - heading_message_new += heading_message_split[i] + "\\" + "_" + with open(file_name, "w", encoding="utf-8") as f: - heading_message_new = heading_message_new[:-2] + heading_message_new = heading_message.replace("_", "\\_") heading_dashes = "=" * len(heading_message_new) f.write(heading_message_new + "\n") @@ -54,4 +50,4 @@ f.close() -print("Successfully updated API documentation!") +print(f"Successfully updated {len(category_lst)} API documentations!") diff --git a/docs/source/reference/pkg_configs.rst b/docs/source/reference/pkg_configs.rst index dd9a128..c97dc04 100644 --- a/docs/source/reference/pkg_configs.rst +++ b/docs/source/reference/pkg_configs.rst @@ -12,4 +12,4 @@ configurations show_util_func_by_category show_util_func_by_keyword - find_func_by_keyword \ No newline at end of file + find_util_func_by_keyword \ No newline at end of file diff --git a/pyufunc/__init__.py b/pyufunc/__init__.py index 59dcede..6629df6 100644 --- a/pyufunc/__init__.py +++ b/pyufunc/__init__.py @@ -70,7 +70,7 @@ "util_vis" : __util_vis.__all__, "pkg_utils" : __pkg_utils.__all__ + ["show_util_func_by_category", "show_util_func_by_keyword", - "find_func_by_keyword"], + "find_util_func_by_keyword"], } @@ -169,7 +169,7 @@ def show_util_func_by_keyword(verbose: bool = True) -> None: return res_str -def find_func_by_keyword(keyword: str, verbose: bool = True) -> list: +def find_util_func_by_keyword(keyword: str, verbose: bool = True) -> list: """find all available utility functions in pyufunc by keyword. Args: