docs: add documentation on device, default-nodes and linking scripts

This commit is contained in:
George Kiagiadakis
2023-09-29 16:14:08 +03:00
parent 493be2fae6
commit 2f89c64b7f
10 changed files with 238 additions and 0 deletions

View File

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

View File

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

View File

@@ -0,0 +1,15 @@
.. _existing_scripts:
Existing Scripts
================
This section documents all the existing lua scripts that are shipped with
WirePlumber, including information on the hooks that they provide and
information on how to extend the logic with additional custom scripts & hooks.
.. toctree::
:maxdepth: 1
default_nodes.rst
device.rst
linking.rst

View File

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

View File

@@ -0,0 +1,10 @@
# you need to add here any files you add to the toc directory as well
sphinx_files += files(
'existing_scripts.rst',
'default_nodes.rst',
meson.current_source_dir()/'..'/'..'/'..'/'src'/'scripts'/'default-nodes'/'README.rst',
'device.rst',
meson.current_source_dir()/'..'/'..'/'..'/'src'/'scripts'/'device'/'README.rst',
'linking.rst',
meson.current_source_dir()/'..'/'..'/'..'/'src'/'scripts'/'linking'/'README.rst',
)