Commit 2eac6257 authored by George Kiagiadakis's avatar George Kiagiadakis
Browse files

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

parent 93c2e7d6
.. _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`
......@@ -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,
......
.. _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
# 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',
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment