diff --git a/docs/rst/configuration.rst b/docs/rst/daemon/configuration.rst similarity index 97% rename from docs/rst/configuration.rst rename to docs/rst/daemon/configuration.rst index 2844916b..ba22850a 100644 --- a/docs/rst/configuration.rst +++ b/docs/rst/daemon/configuration.rst @@ -1,4 +1,4 @@ - .. _configuration: +.. _daemon_configuration: Configuration ============= diff --git a/docs/rst/configuration/access.rst b/docs/rst/daemon/configuration/access.rst similarity index 100% rename from docs/rst/configuration/access.rst rename to docs/rst/daemon/configuration/access.rst diff --git a/docs/rst/configuration/alsa.rst b/docs/rst/daemon/configuration/alsa.rst similarity index 100% rename from docs/rst/configuration/alsa.rst rename to docs/rst/daemon/configuration/alsa.rst diff --git a/docs/rst/configuration/bluetooth.rst b/docs/rst/daemon/configuration/bluetooth.rst similarity index 100% rename from docs/rst/configuration/bluetooth.rst rename to docs/rst/daemon/configuration/bluetooth.rst diff --git a/docs/rst/configuration/components_and_profiles.rst b/docs/rst/daemon/configuration/components_and_profiles.rst similarity index 100% rename from docs/rst/configuration/components_and_profiles.rst rename to docs/rst/daemon/configuration/components_and_profiles.rst diff --git a/docs/rst/configuration/conf_file.rst b/docs/rst/daemon/configuration/conf_file.rst similarity index 100% rename from docs/rst/configuration/conf_file.rst rename to docs/rst/daemon/configuration/conf_file.rst diff --git a/docs/rst/configuration/features.rst b/docs/rst/daemon/configuration/features.rst similarity index 100% rename from docs/rst/configuration/features.rst rename to docs/rst/daemon/configuration/features.rst diff --git a/docs/rst/configuration/locations.rst b/docs/rst/daemon/configuration/locations.rst similarity index 100% rename from docs/rst/configuration/locations.rst rename to docs/rst/daemon/configuration/locations.rst diff --git a/docs/rst/configuration/main.rst b/docs/rst/daemon/configuration/main.rst similarity index 99% rename from docs/rst/configuration/main.rst rename to docs/rst/daemon/configuration/main.rst index 3470cde3..2b8407bd 100644 --- a/docs/rst/configuration/main.rst +++ b/docs/rst/daemon/configuration/main.rst @@ -36,7 +36,7 @@ files and are placed under ``wireplumber.conf.d/``. More on this below. This sets the daemon's name to *WirePlumber* and the log level to *2*, which only displays errors and warnings. See the - :ref:`Debug Logging ` section for more details. + :ref:`Debug Logging ` section for more details. * *context.spa-libs* diff --git a/docs/rst/configuration/meson.build b/docs/rst/daemon/configuration/meson.build similarity index 100% rename from docs/rst/configuration/meson.build rename to docs/rst/daemon/configuration/meson.build diff --git a/docs/rst/configuration/multi_instance.rst b/docs/rst/daemon/configuration/multi_instance.rst similarity index 100% rename from docs/rst/configuration/multi_instance.rst rename to docs/rst/daemon/configuration/multi_instance.rst diff --git a/docs/rst/configuration/policy.rst b/docs/rst/daemon/configuration/policy.rst similarity index 100% rename from docs/rst/configuration/policy.rst rename to docs/rst/daemon/configuration/policy.rst diff --git a/docs/rst/configuration/settings.rst b/docs/rst/daemon/configuration/settings.rst similarity index 86% rename from docs/rst/configuration/settings.rst rename to docs/rst/daemon/configuration/settings.rst index 7671a675..ed1b65dc 100644 --- a/docs/rst/configuration/settings.rst +++ b/docs/rst/daemon/configuration/settings.rst @@ -9,4 +9,4 @@ Settings can be either configured statically in the configuration file by setting them under the ``wireplumber.settings`` section, or they can be configured dynamically at runtime by using metadata. -.. include:: ../../../src/scripts/lib/SETTINGS.rst +.. include:: ../../../../src/scripts/lib/SETTINGS.rst diff --git a/docs/rst/installing-wireplumber.rst b/docs/rst/daemon/installing.rst similarity index 99% rename from docs/rst/installing-wireplumber.rst rename to docs/rst/daemon/installing.rst index bf6a116c..a1b0a2e6 100644 --- a/docs/rst/installing-wireplumber.rst +++ b/docs/rst/daemon/installing.rst @@ -1,4 +1,4 @@ - .. _installing-wireplumber: +.. _daemon_installing: Installing WirePlumber ====================== diff --git a/docs/rst/daemon-logging.rst b/docs/rst/daemon/logging.rst similarity index 99% rename from docs/rst/daemon-logging.rst rename to docs/rst/daemon/logging.rst index b16b7a52..39bac1fe 100644 --- a/docs/rst/daemon-logging.rst +++ b/docs/rst/daemon/logging.rst @@ -1,4 +1,4 @@ - .. _logging: +.. _daemon_logging: Debug Logging ============= diff --git a/docs/rst/daemon/meson.build b/docs/rst/daemon/meson.build new file mode 100644 index 00000000..c6361818 --- /dev/null +++ b/docs/rst/daemon/meson.build @@ -0,0 +1,9 @@ +# you need to add here any files you add to the toc directory as well +sphinx_files += files( + 'installing.rst', + 'running.rst', + 'configuration.rst', + 'logging.rst', +) + +subdir('configuration') diff --git a/docs/rst/running-wireplumber-daemon.rst b/docs/rst/daemon/running.rst similarity index 99% rename from docs/rst/running-wireplumber-daemon.rst rename to docs/rst/daemon/running.rst index db500a15..f45099bb 100644 --- a/docs/rst/running-wireplumber-daemon.rst +++ b/docs/rst/daemon/running.rst @@ -1,4 +1,4 @@ - .. _running-wireplumber-daemon: +.. _daemon_running: Running the WirePlumber daemon ============================== diff --git a/docs/rst/design/events_and_hooks.rst b/docs/rst/design/events_and_hooks.rst index 84d69441..2c41494e 100644 --- a/docs/rst/design/events_and_hooks.rst +++ b/docs/rst/design/events_and_hooks.rst @@ -1,4 +1,4 @@ - .. _events_and_hooks: +.. _design_events_and_hooks: Events and Hooks ================ diff --git a/docs/rst/design/understanding_session_management.rst b/docs/rst/design/understanding_session_management.rst index cd76086e..fc188d5b 100644 --- a/docs/rst/design/understanding_session_management.rst +++ b/docs/rst/design/understanding_session_management.rst @@ -1,4 +1,4 @@ - .. _understanding_session_management: +.. _design_understanding_session_management: Understanding Session Management ================================ diff --git a/docs/rst/design/understanding_wireplumber.rst b/docs/rst/design/understanding_wireplumber.rst index fcb44268..8cc801e3 100644 --- a/docs/rst/design/understanding_wireplumber.rst +++ b/docs/rst/design/understanding_wireplumber.rst @@ -1,4 +1,4 @@ -.. _understanding_wireplumber: +.. _design_understanding_wireplumber: Understanding WirePlumber ========================= @@ -49,8 +49,8 @@ Session management utilities The library also provides a set of utilities that are useful for session management. For example, it provides the :ref:`WpSessionItem ` class that can be used to abstract a part of the graph with some logic attached -to it. It also provides the :ref:`Events & Hooks API `, which -is a way to express event handling logic in a declarative way. +to it. It also provides the :ref:`Events & Hooks API `, +which is a way to express event handling logic in a declarative way. Misc utilities ^^^^^^^^^^^^^^ diff --git a/docs/rst/index.rst b/docs/rst/index.rst index 34162ed7..e35cf331 100644 --- a/docs/rst/index.rst +++ b/docs/rst/index.rst @@ -7,10 +7,10 @@ Table of Contents :maxdepth: 2 :caption: The WirePlumber Daemon - installing-wireplumber.rst - running-wireplumber-daemon.rst - configuration.rst - daemon-logging.rst + daemon/installing.rst + daemon/running.rst + daemon/configuration.rst + daemon/logging.rst .. toctree:: :maxdepth: 2 @@ -24,20 +24,20 @@ Table of Contents :maxdepth: 2 :caption: The WirePlumber Library - c_api.rst - lua_api.rst + library/c_api.rst .. toctree:: :maxdepth: 2 :caption: Scripting - scripts/existing_scripts.rst + scripting/lua_api.rst + scripting/existing_scripts.rst .. toctree:: :maxdepth: 2 :caption: Resources - contributing.rst - testing.rst - community.rst - releases.rst + resources/contributing.rst + resources/testing.rst + resources/community.rst + resources/releases.rst diff --git a/docs/rst/c_api.rst b/docs/rst/library/c_api.rst similarity index 98% rename from docs/rst/c_api.rst rename to docs/rst/library/c_api.rst index 8a8aa05e..f68ea30b 100644 --- a/docs/rst/c_api.rst +++ b/docs/rst/library/c_api.rst @@ -1,4 +1,4 @@ - .. _library_root: +.. _library_c_api: C API Documentation =================== diff --git a/docs/rst/c_api/client_api.rst b/docs/rst/library/c_api/client_api.rst similarity index 100% rename from docs/rst/c_api/client_api.rst rename to docs/rst/library/c_api/client_api.rst diff --git a/docs/rst/c_api/component_loader_api.rst b/docs/rst/library/c_api/component_loader_api.rst similarity index 100% rename from docs/rst/c_api/component_loader_api.rst rename to docs/rst/library/c_api/component_loader_api.rst diff --git a/docs/rst/c_api/conf_api.rst b/docs/rst/library/c_api/conf_api.rst similarity index 100% rename from docs/rst/c_api/conf_api.rst rename to docs/rst/library/c_api/conf_api.rst diff --git a/docs/rst/c_api/core_api.rst b/docs/rst/library/c_api/core_api.rst similarity index 100% rename from docs/rst/c_api/core_api.rst rename to docs/rst/library/c_api/core_api.rst diff --git a/docs/rst/c_api/device_api.rst b/docs/rst/library/c_api/device_api.rst similarity index 100% rename from docs/rst/c_api/device_api.rst rename to docs/rst/library/c_api/device_api.rst diff --git a/docs/rst/c_api/global_proxy_api.rst b/docs/rst/library/c_api/global_proxy_api.rst similarity index 100% rename from docs/rst/c_api/global_proxy_api.rst rename to docs/rst/library/c_api/global_proxy_api.rst diff --git a/docs/rst/c_api/impl_module_api.rst b/docs/rst/library/c_api/impl_module_api.rst similarity index 100% rename from docs/rst/c_api/impl_module_api.rst rename to docs/rst/library/c_api/impl_module_api.rst diff --git a/docs/rst/c_api/impl_node_api.rst b/docs/rst/library/c_api/impl_node_api.rst similarity index 100% rename from docs/rst/c_api/impl_node_api.rst rename to docs/rst/library/c_api/impl_node_api.rst diff --git a/docs/rst/c_api/iterator_api.rst b/docs/rst/library/c_api/iterator_api.rst similarity index 100% rename from docs/rst/c_api/iterator_api.rst rename to docs/rst/library/c_api/iterator_api.rst diff --git a/docs/rst/c_api/link_api.rst b/docs/rst/library/c_api/link_api.rst similarity index 100% rename from docs/rst/c_api/link_api.rst rename to docs/rst/library/c_api/link_api.rst diff --git a/docs/rst/c_api/log_api.rst b/docs/rst/library/c_api/log_api.rst similarity index 100% rename from docs/rst/c_api/log_api.rst rename to docs/rst/library/c_api/log_api.rst diff --git a/docs/rst/c_api/meson.build b/docs/rst/library/c_api/meson.build similarity index 100% rename from docs/rst/c_api/meson.build rename to docs/rst/library/c_api/meson.build diff --git a/docs/rst/c_api/metadata_api.rst b/docs/rst/library/c_api/metadata_api.rst similarity index 100% rename from docs/rst/c_api/metadata_api.rst rename to docs/rst/library/c_api/metadata_api.rst diff --git a/docs/rst/c_api/node_api.rst b/docs/rst/library/c_api/node_api.rst similarity index 100% rename from docs/rst/c_api/node_api.rst rename to docs/rst/library/c_api/node_api.rst diff --git a/docs/rst/c_api/obj_interest_api.rst b/docs/rst/library/c_api/obj_interest_api.rst similarity index 100% rename from docs/rst/c_api/obj_interest_api.rst rename to docs/rst/library/c_api/obj_interest_api.rst diff --git a/docs/rst/c_api/obj_manager_api.rst b/docs/rst/library/c_api/obj_manager_api.rst similarity index 100% rename from docs/rst/c_api/obj_manager_api.rst rename to docs/rst/library/c_api/obj_manager_api.rst diff --git a/docs/rst/c_api/object_api.rst b/docs/rst/library/c_api/object_api.rst similarity index 100% rename from docs/rst/c_api/object_api.rst rename to docs/rst/library/c_api/object_api.rst diff --git a/docs/rst/c_api/pipewire_object_api.rst b/docs/rst/library/c_api/pipewire_object_api.rst similarity index 100% rename from docs/rst/c_api/pipewire_object_api.rst rename to docs/rst/library/c_api/pipewire_object_api.rst diff --git a/docs/rst/c_api/plugin_api.rst b/docs/rst/library/c_api/plugin_api.rst similarity index 100% rename from docs/rst/c_api/plugin_api.rst rename to docs/rst/library/c_api/plugin_api.rst diff --git a/docs/rst/c_api/port_api.rst b/docs/rst/library/c_api/port_api.rst similarity index 100% rename from docs/rst/c_api/port_api.rst rename to docs/rst/library/c_api/port_api.rst diff --git a/docs/rst/c_api/properties_api.rst b/docs/rst/library/c_api/properties_api.rst similarity index 100% rename from docs/rst/c_api/properties_api.rst rename to docs/rst/library/c_api/properties_api.rst diff --git a/docs/rst/c_api/proxy_api.rst b/docs/rst/library/c_api/proxy_api.rst similarity index 100% rename from docs/rst/c_api/proxy_api.rst rename to docs/rst/library/c_api/proxy_api.rst diff --git a/docs/rst/c_api/session_item_api.rst b/docs/rst/library/c_api/session_item_api.rst similarity index 100% rename from docs/rst/c_api/session_item_api.rst rename to docs/rst/library/c_api/session_item_api.rst diff --git a/docs/rst/c_api/settings_api.rst b/docs/rst/library/c_api/settings_api.rst similarity index 100% rename from docs/rst/c_api/settings_api.rst rename to docs/rst/library/c_api/settings_api.rst diff --git a/docs/rst/c_api/si_factory_api.rst b/docs/rst/library/c_api/si_factory_api.rst similarity index 100% rename from docs/rst/c_api/si_factory_api.rst rename to docs/rst/library/c_api/si_factory_api.rst diff --git a/docs/rst/c_api/si_interfaces_api.rst b/docs/rst/library/c_api/si_interfaces_api.rst similarity index 100% rename from docs/rst/c_api/si_interfaces_api.rst rename to docs/rst/library/c_api/si_interfaces_api.rst diff --git a/docs/rst/c_api/spa_device_api.rst b/docs/rst/library/c_api/spa_device_api.rst similarity index 100% rename from docs/rst/c_api/spa_device_api.rst rename to docs/rst/library/c_api/spa_device_api.rst diff --git a/docs/rst/c_api/spa_json_api.rst b/docs/rst/library/c_api/spa_json_api.rst similarity index 100% rename from docs/rst/c_api/spa_json_api.rst rename to docs/rst/library/c_api/spa_json_api.rst diff --git a/docs/rst/c_api/spa_pod_api.rst b/docs/rst/library/c_api/spa_pod_api.rst similarity index 100% rename from docs/rst/c_api/spa_pod_api.rst rename to docs/rst/library/c_api/spa_pod_api.rst diff --git a/docs/rst/c_api/spa_type_api.rst b/docs/rst/library/c_api/spa_type_api.rst similarity index 100% rename from docs/rst/c_api/spa_type_api.rst rename to docs/rst/library/c_api/spa_type_api.rst diff --git a/docs/rst/c_api/state_api.rst b/docs/rst/library/c_api/state_api.rst similarity index 100% rename from docs/rst/c_api/state_api.rst rename to docs/rst/library/c_api/state_api.rst diff --git a/docs/rst/c_api/transitions_api.rst b/docs/rst/library/c_api/transitions_api.rst similarity index 100% rename from docs/rst/c_api/transitions_api.rst rename to docs/rst/library/c_api/transitions_api.rst diff --git a/docs/rst/c_api/wp_api.rst b/docs/rst/library/c_api/wp_api.rst similarity index 100% rename from docs/rst/c_api/wp_api.rst rename to docs/rst/library/c_api/wp_api.rst diff --git a/docs/rst/c_api/wperror_api.rst b/docs/rst/library/c_api/wperror_api.rst similarity index 100% rename from docs/rst/c_api/wperror_api.rst rename to docs/rst/library/c_api/wperror_api.rst diff --git a/docs/rst/library/meson.build b/docs/rst/library/meson.build new file mode 100644 index 00000000..c8506699 --- /dev/null +++ b/docs/rst/library/meson.build @@ -0,0 +1,6 @@ +# you need to add here any files you add to the toc directory as well +sphinx_files += files( + 'c_api.rst', +) + +subdir('c_api') diff --git a/docs/rst/meson.build b/docs/rst/meson.build index ec291546..30749eae 100644 --- a/docs/rst/meson.build +++ b/docs/rst/meson.build @@ -1,20 +1,10 @@ # you need to add here any files you add to the toc directory as well sphinx_files += files( 'index.rst', - 'installing-wireplumber.rst', - 'running-wireplumber-daemon.rst', - 'configuration.rst', - 'daemon-logging.rst', - 'contributing.rst', - 'community.rst', - 'testing.rst', - 'releases.rst', - 'c_api.rst', - 'lua_api.rst', ) -subdir('c_api') -subdir('lua_api') -subdir('configuration') +subdir('daemon') subdir('design') -subdir('scripts') +subdir('library') +subdir('scripting') +subdir('resources') diff --git a/docs/rst/releases.rst b/docs/rst/releases.rst deleted file mode 100644 index 415eea36..00000000 --- a/docs/rst/releases.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _releases: - -Releases -======== - -.. include:: ../../NEWS.rst diff --git a/docs/rst/community.rst b/docs/rst/resources/community.rst similarity index 97% rename from docs/rst/community.rst rename to docs/rst/resources/community.rst index 46288bb0..61619582 100644 --- a/docs/rst/community.rst +++ b/docs/rst/resources/community.rst @@ -1,4 +1,4 @@ - .. _community: +.. _resources_community: Community Resources =================== diff --git a/docs/rst/contributing.rst b/docs/rst/resources/contributing.rst similarity index 97% rename from docs/rst/contributing.rst rename to docs/rst/resources/contributing.rst index 1cebc0f5..d11dcca5 100644 --- a/docs/rst/contributing.rst +++ b/docs/rst/resources/contributing.rst @@ -1,4 +1,4 @@ - .. _contributing: +.. _resources_contributing: Contributing to WirePlumber =========================== @@ -25,7 +25,7 @@ the indentation settings. Tests ----- -See :ref:`testing` +See :ref:`resources_testing` Running in gdb / valgrind / etc... ---------------------------------- diff --git a/docs/rst/resources/meson.build b/docs/rst/resources/meson.build new file mode 100644 index 00000000..0e336bad --- /dev/null +++ b/docs/rst/resources/meson.build @@ -0,0 +1,7 @@ +# you need to add here any files you add to the toc directory as well +sphinx_files += files( + 'contributing.rst', + 'testing.rst', + 'community.rst', + 'releases.rst', +) diff --git a/docs/rst/resources/releases.rst b/docs/rst/resources/releases.rst new file mode 100644 index 00000000..cb091cd2 --- /dev/null +++ b/docs/rst/resources/releases.rst @@ -0,0 +1,6 @@ +.. _resources_releases: + +Releases +======== + +.. include:: ../../../NEWS.rst diff --git a/docs/rst/testing.rst b/docs/rst/resources/testing.rst similarity index 99% rename from docs/rst/testing.rst rename to docs/rst/resources/testing.rst index 4ca62404..4e6e7e98 100644 --- a/docs/rst/testing.rst +++ b/docs/rst/resources/testing.rst @@ -1,4 +1,4 @@ - .. _testing: +.. _resources_testing: Testing ======= diff --git a/docs/rst/scripts/existing_scripts.rst b/docs/rst/scripting/existing_scripts.rst similarity index 68% rename from docs/rst/scripts/existing_scripts.rst rename to docs/rst/scripting/existing_scripts.rst index a9ea0c3b..8a72c4af 100644 --- a/docs/rst/scripts/existing_scripts.rst +++ b/docs/rst/scripting/existing_scripts.rst @@ -1,4 +1,4 @@ - .. _existing_scripts: +.. _scripting_existing_scripts: Existing Scripts ================ @@ -10,6 +10,6 @@ information on how to extend the logic with additional custom scripts & hooks. .. toctree:: :maxdepth: 1 - default_nodes.rst - device.rst - linking.rst + existing_scripts/default_nodes.rst + existing_scripts/device.rst + existing_scripts/linking.rst diff --git a/docs/rst/scripting/existing_scripts/default_nodes.rst b/docs/rst/scripting/existing_scripts/default_nodes.rst new file mode 100644 index 00000000..f90e71a7 --- /dev/null +++ b/docs/rst/scripting/existing_scripts/default_nodes.rst @@ -0,0 +1,3 @@ +.. _existing_scripts_default_nodes: + +.. include:: ../../../../src/scripts/default-nodes/README.rst diff --git a/docs/rst/scripting/existing_scripts/device.rst b/docs/rst/scripting/existing_scripts/device.rst new file mode 100644 index 00000000..f9c8938e --- /dev/null +++ b/docs/rst/scripting/existing_scripts/device.rst @@ -0,0 +1,3 @@ +.. _existing_scripts_device: + +.. include:: ../../../../src/scripts/device/README.rst diff --git a/docs/rst/scripting/existing_scripts/linking.rst b/docs/rst/scripting/existing_scripts/linking.rst new file mode 100644 index 00000000..db65ce6c --- /dev/null +++ b/docs/rst/scripting/existing_scripts/linking.rst @@ -0,0 +1,3 @@ +.. _existing_scripts_linking: + +.. include:: ../../../../src/scripts/linking/README.rst diff --git a/docs/rst/scripts/meson.build b/docs/rst/scripting/existing_scripts/meson.build similarity index 85% rename from docs/rst/scripts/meson.build rename to docs/rst/scripting/existing_scripts/meson.build index abaa7be2..3f971f0c 100644 --- a/docs/rst/scripts/meson.build +++ b/docs/rst/scripting/existing_scripts/meson.build @@ -1,6 +1,5 @@ # you need to add here any files you add to the toc directory as well sphinx_files += files( - 'existing_scripts.rst', 'default_nodes.rst', 'device.rst', 'linking.rst', diff --git a/docs/rst/lua_api.rst b/docs/rst/scripting/lua_api.rst similarity index 95% rename from docs/rst/lua_api.rst rename to docs/rst/scripting/lua_api.rst index 40f8931a..d556e042 100644 --- a/docs/rst/lua_api.rst +++ b/docs/rst/scripting/lua_api.rst @@ -1,4 +1,4 @@ - .. _lua_api: +.. _scripting_lua_api: Lua API Documentation ===================== diff --git a/docs/rst/lua_api/lua_core_api.rst b/docs/rst/scripting/lua_api/lua_core_api.rst similarity index 100% rename from docs/rst/lua_api/lua_core_api.rst rename to docs/rst/scripting/lua_api/lua_core_api.rst diff --git a/docs/rst/lua_api/lua_gobject.rst b/docs/rst/scripting/lua_api/lua_gobject.rst similarity index 100% rename from docs/rst/lua_api/lua_gobject.rst rename to docs/rst/scripting/lua_api/lua_gobject.rst diff --git a/docs/rst/lua_api/lua_introduction.rst b/docs/rst/scripting/lua_api/lua_introduction.rst similarity index 95% rename from docs/rst/lua_api/lua_introduction.rst rename to docs/rst/scripting/lua_api/lua_introduction.rst index f672978a..cebe567f 100644 --- a/docs/rst/lua_api/lua_introduction.rst +++ b/docs/rst/scripting/lua_api/lua_introduction.rst @@ -40,7 +40,7 @@ In this environment, the following rules apply: Here is a full list of Lua functions (and API tables) that are exposed: - .. literalinclude:: ../../../modules/module-lua-scripting/wplua/sandbox.lua + .. literalinclude:: ../../../../modules/module-lua-scripting/wplua/sandbox.lua :language: lua :lines: 27-30 diff --git a/docs/rst/lua_api/lua_local_module_api.rst b/docs/rst/scripting/lua_api/lua_local_module_api.rst similarity index 100% rename from docs/rst/lua_api/lua_local_module_api.rst rename to docs/rst/scripting/lua_api/lua_local_module_api.rst diff --git a/docs/rst/lua_api/lua_log_api.rst b/docs/rst/scripting/lua_api/lua_log_api.rst similarity index 100% rename from docs/rst/lua_api/lua_log_api.rst rename to docs/rst/scripting/lua_api/lua_log_api.rst diff --git a/docs/rst/lua_api/lua_object_api.rst b/docs/rst/scripting/lua_api/lua_object_api.rst similarity index 100% rename from docs/rst/lua_api/lua_object_api.rst rename to docs/rst/scripting/lua_api/lua_object_api.rst diff --git a/docs/rst/lua_api/lua_object_interest_api.rst b/docs/rst/scripting/lua_api/lua_object_interest_api.rst similarity index 100% rename from docs/rst/lua_api/lua_object_interest_api.rst rename to docs/rst/scripting/lua_api/lua_object_interest_api.rst diff --git a/docs/rst/lua_api/lua_object_manager_api.rst b/docs/rst/scripting/lua_api/lua_object_manager_api.rst similarity index 100% rename from docs/rst/lua_api/lua_object_manager_api.rst rename to docs/rst/scripting/lua_api/lua_object_manager_api.rst diff --git a/docs/rst/lua_api/lua_proxies_api.rst b/docs/rst/scripting/lua_api/lua_proxies_api.rst similarity index 100% rename from docs/rst/lua_api/lua_proxies_api.rst rename to docs/rst/scripting/lua_api/lua_proxies_api.rst diff --git a/docs/rst/lua_api/lua_session_item_api.rst b/docs/rst/scripting/lua_api/lua_session_item_api.rst similarity index 100% rename from docs/rst/lua_api/lua_session_item_api.rst rename to docs/rst/scripting/lua_api/lua_session_item_api.rst diff --git a/docs/rst/lua_api/lua_spa_device_api.rst b/docs/rst/scripting/lua_api/lua_spa_device_api.rst similarity index 100% rename from docs/rst/lua_api/lua_spa_device_api.rst rename to docs/rst/scripting/lua_api/lua_spa_device_api.rst diff --git a/docs/rst/lua_api/lua_spa_pod.rst b/docs/rst/scripting/lua_api/lua_spa_pod.rst similarity index 100% rename from docs/rst/lua_api/lua_spa_pod.rst rename to docs/rst/scripting/lua_api/lua_spa_pod.rst diff --git a/docs/rst/lua_api/meson.build b/docs/rst/scripting/lua_api/meson.build similarity index 100% rename from docs/rst/lua_api/meson.build rename to docs/rst/scripting/lua_api/meson.build diff --git a/docs/rst/scripting/meson.build b/docs/rst/scripting/meson.build new file mode 100644 index 00000000..e6324f49 --- /dev/null +++ b/docs/rst/scripting/meson.build @@ -0,0 +1,8 @@ +# you need to add here any files you add to the toc directory as well +sphinx_files += files( + 'lua_api.rst', + 'existing_scripts.rst', +) + +subdir('lua_api') +subdir('existing_scripts') diff --git a/docs/rst/scripts/default_nodes.rst b/docs/rst/scripts/default_nodes.rst deleted file mode 100644 index f608c7a7..00000000 --- a/docs/rst/scripts/default_nodes.rst +++ /dev/null @@ -1,3 +0,0 @@ - .. _default_nodes_scripts: - -.. include:: ../../../src/scripts/default-nodes/README.rst diff --git a/docs/rst/scripts/device.rst b/docs/rst/scripts/device.rst deleted file mode 100644 index 3b95ecdd..00000000 --- a/docs/rst/scripts/device.rst +++ /dev/null @@ -1,3 +0,0 @@ - .. _device_scripts: - -.. include:: ../../../src/scripts/device/README.rst diff --git a/docs/rst/scripts/linking.rst b/docs/rst/scripts/linking.rst deleted file mode 100644 index 3930582a..00000000 --- a/docs/rst/scripts/linking.rst +++ /dev/null @@ -1,3 +0,0 @@ - .. _linking_scripts: - -.. include:: ../../../src/scripts/linking/README.rst