bbf6ea0b4f
This is adds basic configuration files for doxygen and for breathe, which is a doxygen-to-sphinx bridge that can document C symbols. Breathe is configured with default project 'weston' and implicitly adds :members: and :undoc-members: to breathe configuration options. This allows a shorter way to call breathe directives without the need specify the project and also to display implicitly all the members, documented or not. A 'docs' run_target to force the docs to be re-built has been added. Initially (the first time the build system is ran) the documentation will automatically be built, but later re-builds will require the use of the 'docs' target. This avoid further delays in building weston but in the same time allows the possiblity to update/improve the documentation bits to those who want that. Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
33 lines
983 B
ReStructuredText
33 lines
983 B
ReStructuredText
Welcome to Weston documentation!
|
|
================================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
toc/libweston.rst
|
|
|
|
Weston
|
|
------
|
|
|
|
Weston is the reference implementation of a Wayland compositor, as well as a
|
|
useful environment in and of itself.
|
|
|
|
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 allowing
|
|
other projects to build their own 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`
|