From fb77a9fcc7287b2856961c29021039da572e6c30 Mon Sep 17 00:00:00 2001 From: George Kiagiadakis Date: Sun, 23 May 2021 13:19:19 +0300 Subject: [PATCH] docs: improve the home page and toc; use README.rst as a base; add badges --- README.md | 11 ----------- README.rst | 34 ++++++++++++++++++++++++++++++++++ docs/_static/custom.css | 5 +++++ docs/meson.build | 5 ++++- docs/rst/index.rst | 31 ++++++------------------------- 5 files changed, 49 insertions(+), 37 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index b767efda..00000000 --- a/README.md +++ /dev/null @@ -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/) diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..d0172cea --- /dev/null +++ b/README.rst @@ -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 `_ 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 `_ diff --git a/docs/_static/custom.css b/docs/_static/custom.css index a4f399d5..c0a16ad9 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -35,3 +35,8 @@ div.graphviz { padding-top: 1em; padding-bottom: 1em; } + +/* space between badges */ +img+img { + padding-left: 0.5em; +} diff --git a/docs/meson.build b/docs/meson.build index fd5c6b27..bbf775e7 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -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() diff --git a/docs/rst/index.rst b/docs/rst/index.rst index 0f27242e..c2e4642c 100644 --- a/docs/rst/index.rst +++ b/docs/rst/index.rst @@ -1,46 +1,27 @@ -Wireplumber -=========== +.. include:: ../../README.rst -WirePlumber is a modular session / policy manager for -`PipeWire `_ 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