docs: shuffle files to have the same logical hierarchy as on the generated doc

Also:
 - rename some files to remove redundant information from the filenames
 - rename many labels to match the filename and its place in the hierarchy
 - move lua_api under the scripting section

docs/rst/daemon/configuration.rst

@@ -1,4 +1,4 @@
- .. _configuration:
+.. _daemon_configuration:
 
 Configuration
 =============

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 <logging>` section for more details.
+  :ref:`Debug Logging <daemon_logging>` section for more details.
 
 * *context.spa-libs*
 

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

docs/rst/daemon/installing.rst

@@ -1,4 +1,4 @@
- .. _installing-wireplumber:
+.. _daemon_installing:
 
 Installing WirePlumber
 ======================

docs/rst/daemon/logging.rst

@@ -1,4 +1,4 @@
- .. _logging:
+.. _daemon_logging:
 
 Debug Logging
 =============

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')

docs/rst/daemon/running.rst

@@ -1,4 +1,4 @@
- .. _running-wireplumber-daemon:
+.. _daemon_running:
 
 Running the WirePlumber daemon
 ==============================

docs/rst/design/events_and_hooks.rst

@@ -1,4 +1,4 @@
- .. _events_and_hooks:
+.. _design_events_and_hooks:
 
 Events and Hooks
 ================

docs/rst/design/understanding_session_management.rst

@@ -1,4 +1,4 @@
- .. _understanding_session_management:
+.. _design_understanding_session_management:
 
 Understanding Session Management
 ================================

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 <session_item_api>`
 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 <events_and_hooks>`, which
-is a way to express event handling logic in a declarative way.
+to it. It also provides the :ref:`Events & Hooks API <design_events_and_hooks>`,
+which is a way to express event handling logic in a declarative way.
 
 Misc utilities
 ^^^^^^^^^^^^^^

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

docs/rst/library/c_api.rst

@@ -1,4 +1,4 @@
- .. _library_root:
+.. _library_c_api:
 
 C API Documentation
 ===================

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')

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')

docs/rst/releases.rst

@@ -1,6 +0,0 @@
-.. _releases:
-
-Releases
-========
-
-.. include:: ../../NEWS.rst

docs/rst/resources/community.rst

@@ -1,4 +1,4 @@
- .. _community:
+.. _resources_community:
 
 Community Resources
 ===================

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...
 ----------------------------------

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',
+)

docs/rst/resources/releases.rst

@@ -0,0 +1,6 @@
+.. _resources_releases:
+
+Releases
+========
+
+.. include:: ../../../NEWS.rst

docs/rst/resources/testing.rst

@@ -1,4 +1,4 @@
- .. _testing:
+.. _resources_testing:
 
 Testing
 =======

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

docs/rst/scripting/existing_scripts/default_nodes.rst

@@ -0,0 +1,3 @@
+.. _existing_scripts_default_nodes:
+
+.. include:: ../../../../src/scripts/default-nodes/README.rst

docs/rst/scripting/existing_scripts/device.rst

@@ -0,0 +1,3 @@
+.. _existing_scripts_device:
+
+.. include:: ../../../../src/scripts/device/README.rst

docs/rst/scripting/existing_scripts/linking.rst

@@ -0,0 +1,3 @@
+.. _existing_scripts_linking:
+
+.. include:: ../../../../src/scripts/linking/README.rst

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',

docs/rst/scripting/lua_api.rst

@@ -1,4 +1,4 @@
- .. _lua_api:
+.. _scripting_lua_api:
 
 Lua API Documentation
 =====================

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
 

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')

docs/rst/scripts/default_nodes.rst

@@ -1,3 +0,0 @@
- .. _default_nodes_scripts:
-
-.. include:: ../../../src/scripts/default-nodes/README.rst

docs/rst/scripts/device.rst

@@ -1,3 +0,0 @@
- .. _device_scripts:
-
-.. include:: ../../../src/scripts/device/README.rst

docs/rst/scripts/linking.rst

@@ -1,3 +0,0 @@
- .. _linking_scripts:
-
-.. include:: ../../../src/scripts/linking/README.rst