docs: reorganize .rst files and add tables of contents for the APIs

docs/api/library_root.rst

@@ -1,31 +0,0 @@
- .. _library_root:
-
-API Documentation
-=================
-
-* :ref:`client_api`
-* :ref:`components_api`
-* :ref:`core_api`
-* :ref:`device_api`
-* :ref:`endpoint_api`
-* :ref:`global_proxy_api`
-* :ref:`iterator_api`
-* :ref:`link_api`
-* :ref:`metadata_api`
-* :ref:`node_api`
-* :ref:`obj_interest_api`
-* :ref:`obj_manager_api`
-* :ref:`object_api`
-* :ref:`plugin_api`
-* :ref:`port_api`
-* :ref:`properties_api`
-* :ref:`proxy_interfaces_api`
-* :ref:`proxy_api`
-* :ref:`session_item_api`
-* :ref:`si_factory_api`
-* :ref:`si_interfaces_api`
-* :ref:`state_api`
-* :ref:`transitions_api`
-* :ref:`spa_type_api`
-* :ref:`spa_pod_api`
-* :ref:`wp_api`

docs/meson.build

@@ -74,9 +74,8 @@ if build_doc
     build_by_default: true,
   )
 
-  sphinx_files = files('index.rst')
-  subdir('api')
-  subdir('toc')
+  sphinx_files = []
+  subdir('rst')
 
   sphinx_conf_data = configuration_data()
   sphinx_conf_data.set('OUTDIR', meson.current_build_dir())
@@ -89,13 +88,13 @@ if build_doc
 
   custom_target('doc',
     command: [sphinx_p,
-      '-q',                   # quiet
-      '-E',                   # rebuild from scratch
-      '-j', 'auto',           # parallel build
-      '-d', '@PRIVATE_DIR@',  # doctrees dir
-      '-c', '@OUTDIR@',       # conf.py dir
-      '@CURRENT_SOURCE_DIR@', # source dir
-      '@OUTPUT@',             # output dir
+      '-q',                       # quiet
+      '-E',                       # rebuild from scratch
+      '-j', 'auto',               # parallel build
+      '-d', '@PRIVATE_DIR@',      # doctrees dir
+      '-c', '@OUTDIR@',           # conf.py dir
+      '@CURRENT_SOURCE_DIR@/rst', # source dir
+      '@OUTPUT@',                 # output dir
     ],
     depend_files: [
       sphinx_conf, sphinx_files,

docs/rst/c_api.rst

@@ -0,0 +1,35 @@
+ .. _library_root:
+
+C API Documentation
+=================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   c_api/client_api.rst
+   c_api/components_api.rst
+   c_api/core_api.rst
+   c_api/device_api.rst
+   c_api/endpoint_api.rst
+   c_api/global_proxy_api.rst
+   c_api/iterator_api.rst
+   c_api/link_api.rst
+   c_api/metadata_api.rst
+   c_api/node_api.rst
+   c_api/obj_interest_api.rst
+   c_api/obj_manager_api.rst
+   c_api/object_api.rst
+   c_api/plugin_api.rst
+   c_api/port_api.rst
+   c_api/properties_api.rst
+   c_api/proxy_interfaces_api.rst
+   c_api/proxy_api.rst
+   c_api/session_item_api.rst
+   c_api/si_factory_api.rst
+   c_api/si_interfaces_api.rst
+   c_api/state_api.rst
+   c_api/transitions_api.rst
+   c_api/spa_type_api.rst
+   c_api/spa_pod_api.rst
+   c_api/wp_api.rst

docs/rst/c_api/meson.build

@@ -1,6 +1,5 @@
 # you need to add here any files you add to the api directory as well
 sphinx_files += files(
-  'library_root.rst',
   'client_api.rst',
   'components_api.rst',
   'core_api.rst',

docs/rst/index.rst

@@ -4,17 +4,18 @@ Wireplumber
 WirePlumber is a modular session / policy manager for `PipeWire <https://pipewire.org>`_ and a GObject-based high-level library that wraps PipeWire's API, providing convenience for writing the daemon's modules as well as external tools for managing PipeWire.
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Contents:
 
-   toc/installing-wireplumber.rst
-   toc/running-wireplumber-daemon.rst
-   toc/daemon-configuration.rst
-   toc/daemon-logging.rst
-   toc/contributing.rst
-   toc/community.rst
-   toc/testing.rst
-   api/library_root.rst
+   installing-wireplumber.rst
+   running-wireplumber-daemon.rst
+   daemon-configuration.rst
+   daemon-logging.rst
+   contributing.rst
+   community.rst
+   testing.rst
+   c_api.rst
+   lua_api.rst
 
 The WirePlumber Daemon
 ----------------------
@@ -52,4 +53,4 @@ Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`search`
+* :ref:`search`

docs/rst/lua_api.rst

@@ -0,0 +1,24 @@
+ .. _lua_api:
+
+Lua API Documentation
+=====================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   lua_api/lua_core_api.rst
+   lua_api/lua_client_api.rst
+   lua_api/lua_endpoint_api.rst
+   lua_api/lua_global_proxy_api.rst
+   lua_api/lua_metadata_api.rst
+   lua_api/lua_node_api.rst
+   lua_api/lua_object_api.rst
+   lua_api/lua_object_interest_api.rst
+   lua_api/lua_object_manager_api.rst
+   lua_api/lua_pipewire_object_api.rst
+   lua_api/lua_proxy_api.rst
+   lua_api/lua_session_bin_api.rst
+   lua_api/lua_session_item_api.rst
+   lua_api/lua_source_api.rst
+   lua_api/lua_spa_device_api.rst

docs/rst/meson.build

@@ -1,5 +1,6 @@
 # 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',
   'daemon-configuration.rst',
@@ -7,7 +8,9 @@ sphinx_files += files(
   'contributing.rst',
   'community.rst',
   'testing.rst',
-  'lua_api.rst'
+  'c_api.rst',
+  'lua_api.rst',
 )
 
+subdir('c_api')
 subdir('lua_api')

docs/toc/lua_api.rst

@@ -1,20 +0,0 @@
- .. _lua_api:
-
-Lua API Documentation
-=====================
-
-* :ref:`lua_core_api`
-* :ref:`lua_client_api`
-* :ref:`lua_endpoint_api`
-* :ref:`lua_global_proxy_api`
-* :ref:`lua_metadata_api`
-* :ref:`lua_node_api`
-* :ref:`lua_object_api`
-* :ref:`lua_object_interest_api`
-* :ref:`lua_object_manager_api`
-* :ref:`lua_pipewire_object_api`
-* :ref:`lua_proxy_api`
-* :ref:`lua_session_bin_api`
-* :ref:`lua_session_item_api`
-* :ref:`lua_source_api`
-* :ref:`lua_spa_device_api`