weston/doc/sphinx/index.rst
Marius Vlad 66bea2727e doc: Fix index.rst still mentioning Weston ref compositor
Unfortunately this missed out the release but let's correct it to avoid
people quoting that.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
2026-02-25 11:01:14 +02:00

38 lines
1.1 KiB
ReStructuredText

Welcome to Weston documentation!
================================
.. toctree::
:maxdepth: 2
:caption: Contents:
toc/running-weston.rst
toc/libweston.rst
toc/test-suite.rst
toc/kiosk-shell.rst
toc/ivi-shell.rst
Weston
------
Weston is a Wayland compositor designed for correctness, reliability,
predictability, and performance.
Out of the box, Weston provides a very basic desktop, or a full-featured
environment for non-desktop uses such as automotive, embedded, in-flight,
industrial, kiosks, set-top boxes and TVs.
It also provides a library called :ref:`libweston-label` which allows
users to build their own custom full-featured environments on top of
Weston's core.
The core focus of Weston is correctness and reliability. Weston aims to be lean
and fast, but more importantly, to be predictable. Whilst Weston does have
known bugs and shortcomings, we avoid unknown or variable behaviour as much as
possible, including variable performance such as occasional spikes in frame
display time.
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`