Build reference for missing __init__.py files (#3227)

docs/build_reference.py

@@ -42,6 +42,7 @@ def create_markdown(py_filepath, module_path, classes, functions):
             if len(header_parts) >= 3:
                 header_content = f"{header_parts[0]}---{header_parts[1]}---\n\n"
 
+    module_path = module_path.replace('.__init__', '')
     md_content = [f"# {class_name}\n---\n:::{module_path}.{class_name}\n<br><br>\n" for class_name in classes]
     md_content.extend(f"# {func_name}\n---\n:::{module_path}.{func_name}\n<br><br>\n" for func_name in functions)
     md_content = header_content + "\n".join(md_content)
@@ -98,7 +99,7 @@ def main():
     nav_items = []
     for root, _, files in os.walk(CODE_DIR):
         for file in files:
-            if file.endswith(".py") and file != "__init__.py":
+            if file.endswith(".py"):
                 py_filepath = Path(root) / file
                 classes, functions = extract_classes_and_functions(py_filepath)
 

docs/reference/hub/__init__.md

@@ -0,0 +1,44 @@
+---
+description: Access Ultralytics HUB, manage API keys, train models, and export in various formats with ease using the HUB API.
+keywords: Ultralytics, YOLO, Docs HUB, API, login, logout, reset model, export model, check dataset, HUBDatasetStats, YOLO training, YOLO model
+---
+
+# login
+---
+:::ultralytics.hub.login
+<br><br>
+
+# logout
+---
+:::ultralytics.hub.logout
+<br><br>
+
+# start
+---
+:::ultralytics.hub.start
+<br><br>
+
+# reset_model
+---
+:::ultralytics.hub.reset_model
+<br><br>
+
+# export_fmts_hub
+---
+:::ultralytics.hub.export_fmts_hub
+<br><br>
+
+# export_model
+---
+:::ultralytics.hub.export_model
+<br><br>
+
+# get_export
+---
+:::ultralytics.hub.get_export
+<br><br>
+
+# check_dataset
+---
+:::ultralytics.hub.check_dataset
+<br><br>

docs/reference/yolo/cfg/__init__.md

@@ -0,0 +1,49 @@
+---
+description: Explore Ultralytics YOLO's configuration functions and tools. Handle settings, manage defaults, and deal with deprecations in your YOLO configuration.
+keywords: Ultralytics, YOLO, configuration, cfg2dict, get_cfg, handle_deprecation, check_cfg_mismatch, merge_equals_args, handle_yolo_hub, handle_yolo_settings, entrypoint, copy_default_cfg
+---
+
+# cfg2dict
+---
+:::ultralytics.yolo.cfg.cfg2dict
+<br><br>
+
+# get_cfg
+---
+:::ultralytics.yolo.cfg.get_cfg
+<br><br>
+
+# _handle_deprecation
+---
+:::ultralytics.yolo.cfg._handle_deprecation
+<br><br>
+
+# check_cfg_mismatch
+---
+:::ultralytics.yolo.cfg.check_cfg_mismatch
+<br><br>
+
+# merge_equals_args
+---
+:::ultralytics.yolo.cfg.merge_equals_args
+<br><br>
+
+# handle_yolo_hub
+---
+:::ultralytics.yolo.cfg.handle_yolo_hub
+<br><br>
+
+# handle_yolo_settings
+---
+:::ultralytics.yolo.cfg.handle_yolo_settings
+<br><br>
+
+# entrypoint
+---
+:::ultralytics.yolo.cfg.entrypoint
+<br><br>
+
+# copy_default_cfg
+---
+:::ultralytics.yolo.cfg.copy_default_cfg
+<br><br>

docs/reference/yolo/utils/__init__.md

@@ -0,0 +1,169 @@
+---
+description: Uncover utility functions in Ultralytics YOLO. Handle YAML, threading, logging, error-checking, and platform identification. Enhance your YOLO development process.
+keywords: Ultralytics, YOLO, utils, SimpleClass, IterableSimpleNamespace, EmojiFilter, TryExcept, plt_settings, set_logging, emojis, yaml_save, yaml_load, yaml_print, is_colab, is_kaggle, is_jupyter, is_docker, is_online, is_pip_package, is_dir_writeable, is_pytest_running, is_github_actions_ci, is_git_dir, get_git_dir, get_git_origin_url, get_git_branch, get_default_args, get_user_config_dir, colorstr, threaded, set_sentry, get_settings, set_settings, deprecation_warn, clean_url, url2file
+---
+
+# SimpleClass
+---
+:::ultralytics.yolo.utils.SimpleClass
+<br><br>
+
+# IterableSimpleNamespace
+---
+:::ultralytics.yolo.utils.IterableSimpleNamespace
+<br><br>
+
+# EmojiFilter
+---
+:::ultralytics.yolo.utils.EmojiFilter
+<br><br>
+
+# TryExcept
+---
+:::ultralytics.yolo.utils.TryExcept
+<br><br>
+
+# plt_settings
+---
+:::ultralytics.yolo.utils.plt_settings
+<br><br>
+
+# set_logging
+---
+:::ultralytics.yolo.utils.set_logging
+<br><br>
+
+# emojis
+---
+:::ultralytics.yolo.utils.emojis
+<br><br>
+
+# yaml_save
+---
+:::ultralytics.yolo.utils.yaml_save
+<br><br>
+
+# yaml_load
+---
+:::ultralytics.yolo.utils.yaml_load
+<br><br>
+
+# yaml_print
+---
+:::ultralytics.yolo.utils.yaml_print
+<br><br>
+
+# is_colab
+---
+:::ultralytics.yolo.utils.is_colab
+<br><br>
+
+# is_kaggle
+---
+:::ultralytics.yolo.utils.is_kaggle
+<br><br>
+
+# is_jupyter
+---
+:::ultralytics.yolo.utils.is_jupyter
+<br><br>
+
+# is_docker
+---
+:::ultralytics.yolo.utils.is_docker
+<br><br>
+
+# is_online
+---
+:::ultralytics.yolo.utils.is_online
+<br><br>
+
+# is_pip_package
+---
+:::ultralytics.yolo.utils.is_pip_package
+<br><br>
+
+# is_dir_writeable
+---
+:::ultralytics.yolo.utils.is_dir_writeable
+<br><br>
+
+# is_pytest_running
+---
+:::ultralytics.yolo.utils.is_pytest_running
+<br><br>
+
+# is_github_actions_ci
+---
+:::ultralytics.yolo.utils.is_github_actions_ci
+<br><br>
+
+# is_git_dir
+---
+:::ultralytics.yolo.utils.is_git_dir
+<br><br>
+
+# get_git_dir
+---
+:::ultralytics.yolo.utils.get_git_dir
+<br><br>
+
+# get_git_origin_url
+---
+:::ultralytics.yolo.utils.get_git_origin_url
+<br><br>
+
+# get_git_branch
+---
+:::ultralytics.yolo.utils.get_git_branch
+<br><br>
+
+# get_default_args
+---
+:::ultralytics.yolo.utils.get_default_args
+<br><br>
+
+# get_user_config_dir
+---
+:::ultralytics.yolo.utils.get_user_config_dir
+<br><br>
+
+# colorstr
+---
+:::ultralytics.yolo.utils.colorstr
+<br><br>
+
+# threaded
+---
+:::ultralytics.yolo.utils.threaded
+<br><br>
+
+# set_sentry
+---
+:::ultralytics.yolo.utils.set_sentry
+<br><br>
+
+# get_settings
+---
+:::ultralytics.yolo.utils.get_settings
+<br><br>
+
+# set_settings
+---
+:::ultralytics.yolo.utils.set_settings
+<br><br>
+
+# deprecation_warn
+---
+:::ultralytics.yolo.utils.deprecation_warn
+<br><br>
+
+# clean_url
+---
+:::ultralytics.yolo.utils.clean_url
+<br><br>
+
+# url2file
+---
+:::ultralytics.yolo.utils.url2file
+<br><br>