fdo-mirrors/wireplumber
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/wireplumber.git synced 2026-05-08 15:08:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

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

Browse source
This commit is contained in:
George Kiagiadakis 2021-05-23 13:19:19 +03:00
parent b812e912d2
commit fb77a9fcc7
5 changed files with 49 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,11 +0,0 @@
# 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/)

34
README.rst Normal file
View file

@ -0,0 +1,34 @@
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/>`_

5
docs/_static/custom.css vendored
View file

@ -35,3 +35,8 @@ div.graphviz {
padding-top: 1em;
padding-bottom: 1em;
}
/* space between badges */
img+img {
padding-left: 0.5em;
}

5
docs/meson.build
View file

@ -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()

31
docs/rst/index.rst
View file

@ -1,46 +1,27 @@
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