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
This commit is contained in:
George Kiagiadakis
@@ -1,4 +1,4 @@
|
|||||||
.. _configuration:
|
.. _daemon_configuration:
|
||||||
|
|
||||||
Configuration
|
Configuration
|
||||||
=============
|
=============
|
||||||
@@ -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
|
This sets the daemon's name to *WirePlumber* and the log level to *2*, which
|
||||||
only displays errors and warnings. See the
|
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*
|
* *context.spa-libs*
|
||||||
|
|
||||||
@@ -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
|
by setting them under the ``wireplumber.settings`` section, or they can be
|
||||||
configured dynamically at runtime by using metadata.
|
configured dynamically at runtime by using metadata.
|
||||||
|
|
||||||
.. include:: ../../../src/scripts/lib/SETTINGS.rst
|
.. include:: ../../../../src/scripts/lib/SETTINGS.rst
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _installing-wireplumber:
|
.. _daemon_installing:
|
||||||
|
|
||||||
Installing WirePlumber
|
Installing WirePlumber
|
||||||
======================
|
======================
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _logging:
|
.. _daemon_logging:
|
||||||
|
|
||||||
Debug Logging
|
Debug Logging
|
||||||
=============
|
=============
|
||||||
9
docs/rst/daemon/meson.build
Normal file
9
docs/rst/daemon/meson.build
Normal file
@@ -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')
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _running-wireplumber-daemon:
|
.. _daemon_running:
|
||||||
|
|
||||||
Running the WirePlumber daemon
|
Running the WirePlumber daemon
|
||||||
==============================
|
==============================
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _events_and_hooks:
|
.. _design_events_and_hooks:
|
||||||
|
|
||||||
Events and Hooks
|
Events and Hooks
|
||||||
================
|
================
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _understanding_session_management:
|
.. _design_understanding_session_management:
|
||||||
|
|
||||||
Understanding Session Management
|
Understanding Session Management
|
||||||
================================
|
================================
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _understanding_wireplumber:
|
.. _design_understanding_wireplumber:
|
||||||
|
|
||||||
Understanding WirePlumber
|
Understanding WirePlumber
|
||||||
=========================
|
=========================
|
||||||
@@ -49,8 +49,8 @@ Session management utilities
|
|||||||
The library also provides a set of utilities that are useful for session
|
The library also provides a set of utilities that are useful for session
|
||||||
management. For example, it provides the :ref:`WpSessionItem <session_item_api>`
|
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
|
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
|
to it. It also provides the :ref:`Events & Hooks API <design_events_and_hooks>`,
|
||||||
is a way to express event handling logic in a declarative way.
|
which is a way to express event handling logic in a declarative way.
|
||||||
|
|
||||||
Misc utilities
|
Misc utilities
|
||||||
^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^
|
||||||
|
|||||||
@@ -7,10 +7,10 @@ Table of Contents
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: The WirePlumber Daemon
|
:caption: The WirePlumber Daemon
|
||||||
|
|
||||||
installing-wireplumber.rst
|
daemon/installing.rst
|
||||||
running-wireplumber-daemon.rst
|
daemon/running.rst
|
||||||
configuration.rst
|
daemon/configuration.rst
|
||||||
daemon-logging.rst
|
daemon/logging.rst
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
@@ -24,20 +24,20 @@ Table of Contents
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: The WirePlumber Library
|
:caption: The WirePlumber Library
|
||||||
|
|
||||||
c_api.rst
|
library/c_api.rst
|
||||||
lua_api.rst
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Scripting
|
:caption: Scripting
|
||||||
|
|
||||||
scripts/existing_scripts.rst
|
scripting/lua_api.rst
|
||||||
|
scripting/existing_scripts.rst
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:caption: Resources
|
:caption: Resources
|
||||||
|
|
||||||
contributing.rst
|
resources/contributing.rst
|
||||||
testing.rst
|
resources/testing.rst
|
||||||
community.rst
|
resources/community.rst
|
||||||
releases.rst
|
resources/releases.rst
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _library_root:
|
.. _library_c_api:
|
||||||
|
|
||||||
C API Documentation
|
C API Documentation
|
||||||
===================
|
===================
|
||||||
6
docs/rst/library/meson.build
Normal file
6
docs/rst/library/meson.build
Normal file
@@ -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')
|
||||||
@@ -1,20 +1,10 @@
|
|||||||
# you need to add here any files you add to the toc directory as well
|
# you need to add here any files you add to the toc directory as well
|
||||||
sphinx_files += files(
|
sphinx_files += files(
|
||||||
'index.rst',
|
'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('daemon')
|
||||||
subdir('lua_api')
|
|
||||||
subdir('configuration')
|
|
||||||
subdir('design')
|
subdir('design')
|
||||||
subdir('scripts')
|
subdir('library')
|
||||||
|
subdir('scripting')
|
||||||
|
subdir('resources')
|
||||||
|
|||||||
@@ -1,6 +0,0 @@
|
|||||||
.. _releases:
|
|
||||||
|
|
||||||
Releases
|
|
||||||
========
|
|
||||||
|
|
||||||
.. include:: ../../NEWS.rst
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _community:
|
.. _resources_community:
|
||||||
|
|
||||||
Community Resources
|
Community Resources
|
||||||
===================
|
===================
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _contributing:
|
.. _resources_contributing:
|
||||||
|
|
||||||
Contributing to WirePlumber
|
Contributing to WirePlumber
|
||||||
===========================
|
===========================
|
||||||
@@ -25,7 +25,7 @@ the indentation settings.
|
|||||||
Tests
|
Tests
|
||||||
-----
|
-----
|
||||||
|
|
||||||
See :ref:`testing`
|
See :ref:`resources_testing`
|
||||||
|
|
||||||
Running in gdb / valgrind / etc...
|
Running in gdb / valgrind / etc...
|
||||||
----------------------------------
|
----------------------------------
|
||||||
7
docs/rst/resources/meson.build
Normal file
7
docs/rst/resources/meson.build
Normal file
@@ -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',
|
||||||
|
)
|
||||||
6
docs/rst/resources/releases.rst
Normal file
6
docs/rst/resources/releases.rst
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
.. _resources_releases:
|
||||||
|
|
||||||
|
Releases
|
||||||
|
========
|
||||||
|
|
||||||
|
.. include:: ../../../NEWS.rst
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _testing:
|
.. _resources_testing:
|
||||||
|
|
||||||
Testing
|
Testing
|
||||||
=======
|
=======
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _existing_scripts:
|
.. _scripting_existing_scripts:
|
||||||
|
|
||||||
Existing Scripts
|
Existing Scripts
|
||||||
================
|
================
|
||||||
@@ -10,6 +10,6 @@ information on how to extend the logic with additional custom scripts & hooks.
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
default_nodes.rst
|
existing_scripts/default_nodes.rst
|
||||||
device.rst
|
existing_scripts/device.rst
|
||||||
linking.rst
|
existing_scripts/linking.rst
|
||||||
3
docs/rst/scripting/existing_scripts/default_nodes.rst
Normal file
3
docs/rst/scripting/existing_scripts/default_nodes.rst
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
.. _existing_scripts_default_nodes:
|
||||||
|
|
||||||
|
.. include:: ../../../../src/scripts/default-nodes/README.rst
|
||||||
3
docs/rst/scripting/existing_scripts/device.rst
Normal file
3
docs/rst/scripting/existing_scripts/device.rst
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
.. _existing_scripts_device:
|
||||||
|
|
||||||
|
.. include:: ../../../../src/scripts/device/README.rst
|
||||||
3
docs/rst/scripting/existing_scripts/linking.rst
Normal file
3
docs/rst/scripting/existing_scripts/linking.rst
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
.. _existing_scripts_linking:
|
||||||
|
|
||||||
|
.. include:: ../../../../src/scripts/linking/README.rst
|
||||||
@@ -1,6 +1,5 @@
|
|||||||
# you need to add here any files you add to the toc directory as well
|
# you need to add here any files you add to the toc directory as well
|
||||||
sphinx_files += files(
|
sphinx_files += files(
|
||||||
'existing_scripts.rst',
|
|
||||||
'default_nodes.rst',
|
'default_nodes.rst',
|
||||||
'device.rst',
|
'device.rst',
|
||||||
'linking.rst',
|
'linking.rst',
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
.. _lua_api:
|
.. _scripting_lua_api:
|
||||||
|
|
||||||
Lua API Documentation
|
Lua API Documentation
|
||||||
=====================
|
=====================
|
||||||
@@ -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:
|
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
|
:language: lua
|
||||||
:lines: 27-30
|
:lines: 27-30
|
||||||
|
|
||||||
8
docs/rst/scripting/meson.build
Normal file
8
docs/rst/scripting/meson.build
Normal file
@@ -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')
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
.. _default_nodes_scripts:
|
|
||||||
|
|
||||||
.. include:: ../../../src/scripts/default-nodes/README.rst
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
.. _device_scripts:
|
|
||||||
|
|
||||||
.. include:: ../../../src/scripts/device/README.rst
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
.. _linking_scripts:
|
|
||||||
|
|
||||||
.. include:: ../../../src/scripts/linking/README.rst
|
|
||||||
Reference in New Issue
Block a user