From 5588c8c53f2d94cfca632d8001cfe2539ac1bb6a Mon Sep 17 00:00:00 2001 From: Ang Li Date: Mon, 10 Aug 2026 00:45:46 +0000 Subject: [PATCH] docs: enable automatic sphinx-apidoc generation on build --- .gitignore | 3 + docs/conf.py | 31 ++++ docs/mobly.controllers.android_device_lib.rst | 109 -------------- ...ontrollers.android_device_lib.services.rst | 46 ------ docs/mobly.controllers.attenuator_lib.rst | 30 ---- docs/mobly.controllers.rst | 63 --------- docs/mobly.controllers.sniffer_lib.local.rst | 38 ----- docs/mobly.controllers.sniffer_lib.rst | 17 --- docs/mobly.rst | 133 ------------------ 9 files changed, 34 insertions(+), 436 deletions(-) delete mode 100644 docs/mobly.controllers.android_device_lib.rst delete mode 100644 docs/mobly.controllers.android_device_lib.services.rst delete mode 100644 docs/mobly.controllers.attenuator_lib.rst delete mode 100644 docs/mobly.controllers.rst delete mode 100644 docs/mobly.controllers.sniffer_lib.local.rst delete mode 100644 docs/mobly.controllers.sniffer_lib.rst delete mode 100644 docs/mobly.rst diff --git a/.gitignore b/.gitignore index 06591aec8..36941e08a 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,6 @@ Gemfile.lock _site .tox/ venv/ +docs/_build/ +docs/mobly*.rst +docs/modules.rst diff --git a/docs/conf.py b/docs/conf.py index 402967b98..5183aa6b2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,6 +19,8 @@ import os import sys +from sphinx.ext import apidoc + sys.path.insert(0, os.path.abspath(os.path.pardir)) # -- General configuration ------------------------------------------------ @@ -206,3 +208,32 @@ # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html'] + + +def run_apidoc(_): + """Automatically runs sphinx-apidoc on Sphinx builder initialization.""" + cur_dir = os.path.abspath(os.path.dirname(__file__)) + module_dir = os.path.abspath(os.path.join(cur_dir, os.path.pardir, 'mobly')) + output_dir = cur_dir + + excludes = [ + os.path.join(module_dir, '*_test.py'), + os.path.join(module_dir, '**', '*_test.py'), + ] + + apidoc.main( + [ + '-o', + output_dir, + module_dir, + '--force', + '--separate', + '--module-first', + '--no-toc', + ] + + excludes + ) + + +def setup(app): + app.connect('builder-inited', run_apidoc) diff --git a/docs/mobly.controllers.android_device_lib.rst b/docs/mobly.controllers.android_device_lib.rst deleted file mode 100644 index 8f1d3790e..000000000 --- a/docs/mobly.controllers.android_device_lib.rst +++ /dev/null @@ -1,109 +0,0 @@ -mobly.controllers.android\_device\_lib package -============================================== - -Subpackages ------------ - -.. toctree:: - - mobly.controllers.android_device_lib.services - -Submodules ----------- - -mobly.controllers.android\_device\_lib.adb module -------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.adb - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.callback\_handler module ---------------------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.callback_handler - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.errors module ----------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.errors - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.event\_dispatcher module ---------------------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.event_dispatcher - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.fastboot module ------------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.fastboot - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.jsonrpc\_client\_base module -------------------------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.jsonrpc_client_base - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.jsonrpc\_shell\_base module ------------------------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.jsonrpc_shell_base - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.service\_manager module --------------------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.service_manager - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.sl4a\_client module ----------------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.sl4a_client - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.snippet\_client module -------------------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.snippet_client - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.snippet\_event module ------------------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.snippet_event - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: mobly.controllers.android_device_lib - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mobly.controllers.android_device_lib.services.rst b/docs/mobly.controllers.android_device_lib.services.rst deleted file mode 100644 index 2789e8a03..000000000 --- a/docs/mobly.controllers.android_device_lib.services.rst +++ /dev/null @@ -1,46 +0,0 @@ -mobly.controllers.android\_device\_lib.services package -======================================================= - -Submodules ----------- - -mobly.controllers.android\_device\_lib.services.base\_service module --------------------------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.services.base_service - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.services.logcat module -------------------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.services.logcat - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.services.sl4a\_service module --------------------------------------------------------------------- - -.. automodule:: mobly.controllers.android_device_lib.services.sl4a_service - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.android\_device\_lib.services.snippet\_management\_service module ------------------------------------------------------------------------------------ - -.. automodule:: mobly.controllers.android_device_lib.services.snippet_management_service - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: mobly.controllers.android_device_lib.services - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mobly.controllers.attenuator_lib.rst b/docs/mobly.controllers.attenuator_lib.rst deleted file mode 100644 index a3954560b..000000000 --- a/docs/mobly.controllers.attenuator_lib.rst +++ /dev/null @@ -1,30 +0,0 @@ -mobly.controllers.attenuator\_lib package -========================================= - -Submodules ----------- - -mobly.controllers.attenuator\_lib.minicircuits module ------------------------------------------------------ - -.. automodule:: mobly.controllers.attenuator_lib.minicircuits - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.attenuator\_lib.telnet\_scpi\_client module -------------------------------------------------------------- - -.. automodule:: mobly.controllers.attenuator_lib.telnet_scpi_client - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: mobly.controllers.attenuator_lib - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mobly.controllers.rst b/docs/mobly.controllers.rst deleted file mode 100644 index 17de06d8f..000000000 --- a/docs/mobly.controllers.rst +++ /dev/null @@ -1,63 +0,0 @@ -mobly.controllers package -========================= - -Subpackages ------------ - -.. toctree:: - - mobly.controllers.android_device_lib - mobly.controllers.attenuator_lib - mobly.controllers.sniffer_lib - -Submodules ----------- - -mobly.controllers.android\_device module ----------------------------------------- - -.. automodule:: mobly.controllers.android_device - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.attenuator module ------------------------------------ - -.. automodule:: mobly.controllers.attenuator - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.iperf\_server module --------------------------------------- - -.. automodule:: mobly.controllers.iperf_server - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.monsoon module --------------------------------- - -.. automodule:: mobly.controllers.monsoon - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.sniffer module --------------------------------- - -.. automodule:: mobly.controllers.sniffer - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: mobly.controllers - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mobly.controllers.sniffer_lib.local.rst b/docs/mobly.controllers.sniffer_lib.local.rst deleted file mode 100644 index 1924f9a61..000000000 --- a/docs/mobly.controllers.sniffer_lib.local.rst +++ /dev/null @@ -1,38 +0,0 @@ -mobly.controllers.sniffer\_lib.local package -============================================ - -Submodules ----------- - -mobly.controllers.sniffer\_lib.local.local\_base module -------------------------------------------------------- - -.. automodule:: mobly.controllers.sniffer_lib.local.local_base - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.sniffer\_lib.local.tcpdump module ---------------------------------------------------- - -.. automodule:: mobly.controllers.sniffer_lib.local.tcpdump - :members: - :undoc-members: - :show-inheritance: - -mobly.controllers.sniffer\_lib.local.tshark module --------------------------------------------------- - -.. automodule:: mobly.controllers.sniffer_lib.local.tshark - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: mobly.controllers.sniffer_lib.local - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mobly.controllers.sniffer_lib.rst b/docs/mobly.controllers.sniffer_lib.rst deleted file mode 100644 index c3b088de2..000000000 --- a/docs/mobly.controllers.sniffer_lib.rst +++ /dev/null @@ -1,17 +0,0 @@ -mobly.controllers.sniffer\_lib package -====================================== - -Subpackages ------------ - -.. toctree:: - - mobly.controllers.sniffer_lib.local - -Module contents ---------------- - -.. automodule:: mobly.controllers.sniffer_lib - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/mobly.rst b/docs/mobly.rst deleted file mode 100644 index d3e09618a..000000000 --- a/docs/mobly.rst +++ /dev/null @@ -1,133 +0,0 @@ -mobly package -============= - -Subpackages ------------ - -.. toctree:: - - mobly.controllers - -Submodules ----------- - -mobly.asserts module --------------------- - -.. automodule:: mobly.asserts - :members: - :undoc-members: - :show-inheritance: - -mobly.base\_instrumentation\_test module ----------------------------------------- - -.. automodule:: mobly.base_instrumentation_test - :members: - :undoc-members: - :show-inheritance: - -mobly.base\_test module ------------------------ - -.. automodule:: mobly.base_test - :members: - :undoc-members: - :show-inheritance: - -mobly.config\_parser module ---------------------------- - -.. automodule:: mobly.config_parser - :members: - :undoc-members: - :show-inheritance: - -mobly.controller\_manager module --------------------------------- - -.. automodule:: mobly.controller_manager - :members: - :undoc-members: - :show-inheritance: - -mobly.expects module --------------------- - -.. automodule:: mobly.expects - :members: - :undoc-members: - :show-inheritance: - -mobly.keys module ------------------ - -.. automodule:: mobly.keys - :members: - :undoc-members: - :show-inheritance: - -mobly.logger module -------------------- - -.. automodule:: mobly.logger - :members: - :undoc-members: - :show-inheritance: - -mobly.records module --------------------- - -.. automodule:: mobly.records - :members: - :undoc-members: - :show-inheritance: - -mobly.runtime\_test\_info module --------------------------------- - -.. automodule:: mobly.runtime_test_info - :members: - :undoc-members: - :show-inheritance: - -mobly.signals module --------------------- - -.. automodule:: mobly.signals - :members: - :undoc-members: - :show-inheritance: - -mobly.suite\_runner module --------------------------- - -.. automodule:: mobly.suite_runner - :members: - :undoc-members: - :show-inheritance: - -mobly.test\_runner module -------------------------- - -.. automodule:: mobly.test_runner - :members: - :undoc-members: - :show-inheritance: - -mobly.utils module ------------------- - -.. automodule:: mobly.utils - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: mobly - :members: - :undoc-members: - :show-inheritance: