Commit fb77a9fc authored by George Kiagiadakis's avatar George Kiagiadakis
Browse files

docs: improve the home page and toc; use README.rst as a base; add badges

parent b812e912
# 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.
# Getting Started
Please refer to the documentation, which is available online
[here](https://pipewire.pages.freedesktop.org/wireplumber/)
WirePlumber
===========
.. image:: https://gitlab.freedesktop.org/pipewire/wireplumber/badges/master/pipeline.svg
:alt: Pipeline status
.. image:: https://img.shields.io/tokei/lines/gitlab.freedesktop.org/pipewire/wireplumber
:alt: Lines of code
.. image:: https://img.shields.io/badge/license-MIT-green
:alt: License
.. image:: https://img.shields.io/badge/dynamic/json?color=informational&label=tag&query=%24%5B0%5D.name&url=https%3A%2F%2Fgitlab.freedesktop.org%2Fapi%2Fv4%2Fprojects%2F2941%2Frepository%2Ftags
:alt: Tag
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.
The WirePlumber daemon implements the session & policy management service.
It follows a modular design, having plugins that implement the actual
management functionality.
The WirePlumber Library provides API that allows you to extend the WirePlumber
daemon, to write management or status tools for PipeWire
(apps that don't do actual media streaming) and to write custom session managers
for embedded devices.
Documentation
-------------
The latest version of the documentation is available online
`here <https://pipewire.pages.freedesktop.org/wireplumber/>`_
......@@ -35,3 +35,8 @@ div.graphviz {
padding-top: 1em;
padding-bottom: 1em;
}
/* space between badges */
img+img {
padding-left: 0.5em;
}
......@@ -74,7 +74,10 @@ if build_doc
build_by_default: true,
)
sphinx_files = files('_static'/'custom.css')
sphinx_files = files(
'_static'/'custom.css',
meson.source_root()/'README.rst',
)
subdir('rst')
sphinx_conf_data = configuration_data()
......
Wireplumber
===========
.. include:: ../../README.rst
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.
The WirePlumber Daemon
----------------------
The WirePlumber daemon implements the session & policy management service.
It follows a modular design, having plugins that implement the actual
management functionality.
Table of Contents
=================
.. toctree::
:maxdepth: 2
:caption: The WirePlumber Daemon
installing-wireplumber.rst
running-wireplumber-daemon.rst
daemon-configuration.rst
daemon-logging.rst
The WirePlumber library
-----------------------
The WirePlumber Library provides API that allows you to extend the WirePlumber
daemon, to write management or status tools for PipeWire
(apps that don't do actual media streaming) and to write custom session managers
for embedded devices.
.. toctree::
:maxdepth: 2
:caption: The WirePlumber Library
c_api.rst
lua_api.rst
Resources
---------
.. toctree::
:maxdepth: 2
:caption: Resources
contributing.rst
community.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