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

This commit is contained in:
George Kiagiadakis
2021-05-17 18:12:26 +03:00
parent 93c2e7d686
commit 2eac6257d8
57 changed files with 83 additions and 73 deletions

View File

@@ -0,0 +1,8 @@
.. _lua_client_api:
Lua Client Documentation
------------------------
.. doxygenstruct:: Client
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,8 @@
.. _lua_core_api:
Lua Core Documentation
----------------------
.. doxygenstruct:: Core
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,10 @@
.. _lua_endpoint_api:
Lua Endpoint Documentation
--------------------------
.. doxygenstruct:: Endpoint
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,8 @@
.. _lua_global_proxy_api:
Lua Global Proxy Documentation
------------------------------
.. doxygenstruct:: GlobalProxy
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,9 @@
.. _lua_metadata_api:
Lua Metadata Documentation
--------------------------
.. doxygenstruct:: Metadata
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,10 @@
.. _lua_node_api:
Lua Node Documentation
----------------------
.. doxygenstruct:: Node
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,8 @@
.. _lua_object_api:
Lua Object Documentation
------------------------
.. doxygenstruct:: Object
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,8 @@
.. _lua_object_interest_api:
Lua Object Interest Documentation
---------------------------------
.. doxygenstruct:: ObjectInterest
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,9 @@
.. _lua_object_manager_api:
Lua Object Manager Documentation
---------------------------------
.. doxygenstruct:: ObjectManager
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,8 @@
.. _lua_pipewire_object_api:
Lua PipewireObject Documentation
------------------------
.. doxygenstruct:: PipewireObject
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,8 @@
.. _lua_proxy_api:
Lua Proxy Documentation
-----------------------
.. doxygenstruct:: Proxy
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,8 @@
.. _lua_session_bin_api:
Lua Session Bin Documentation
------------------------------
.. doxygenstruct:: SessionBin
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,9 @@
.. _lua_session_item_api:
Lua Session Item Documentation
------------------------------
.. doxygenstruct:: SessionItem
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,8 @@
.. _lua_source_api:
Lua Source Documentation
------------------------
.. doxygenstruct:: Source
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,10 @@
.. _lua_spa_device_api:
Lua Spa Device Documentation
----------------------------
.. doxygenstruct:: SpaDevice
:project: WirePlumber_Lua
:members:

View File

@@ -0,0 +1,18 @@
# you need to add here any files you add to the toc directory as well
sphinx_files += files(
'lua_core_api.rst',
'lua_client_api.rst',
'lua_endpoint_api.rst',
'lua_global_proxy_api.rst',
'lua_metadata_api.rst',
'lua_node_api.rst',
'lua_object_api.rst',
'lua_object_interest_api.rst',
'lua_object_manager_api.rst',
'lua_pipewire_object_api.rst',
'lua_proxy_api.rst',
'lua_session_bin_api.rst',
'lua_session_item_api.rst',
'lua_source_api.rst',
'lua_spa_device_api.rst',
)