libcamera/Documentation/index.rst
Laurent Pinchart c8e2c5adda Documentation: Link to the API documentation generated by Doxygen
Add a link in the toctree to the API documentation.

sphinx doesn't seem to support relative external links, but we can trick
it into thinking the link is absolute by adding '#://' at the end.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2019-01-11 15:26:31 +02:00

27 lines
1 KiB
ReStructuredText

libcamera
=========
Cameras are complex devices that need heavy hardware image processing
operations. Control of the processing is based on advanced algorithms that must
run on a programmable processor. This has traditionally been implemented in a
dedicated MCU in the camera, but in embedded devices algorithms have been moved
to the main CPU to save cost. Blurring the boundary between camera devices and
Linux often left the user with no other option than a vendor-specific
closed-source solution.
To address this problem the Linux media community has very recently started
collaboration with the industry to develop a camera stack that will be
open-source-friendly while still protecting vendor core IP. libcamera was born
out of that collaboration and will offer modern camera support to Linux-based
systems, including traditional Linux distributions, ChromeOS and Android.
.. toctree::
:maxdepth: 2
:caption: Contents:
Home <self>
Docs <docs>
Coding Style <coding-style>
Contribute <contributing>
API <../api-html/index.html#://>