Commit graph

4 commits

Author SHA1 Message Date
Laurent Pinchart
fb45232fe5 Documentation: Rename "API" section to "API Reference"
"API" as a section name is as informative as it is long, that is to say,
not very. Rename it to "API Reference" for improved clarity.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
2024-08-21 12:22:17 +03:00
Laurent Pinchart
ca9ee2127f licenses: Add SPDX headers to RST documentation
The documentation files are licensed under CC-BY-SA-4.0, but this has
never been specified explicitly. Add corresponding SPDX headers.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2020-04-15 19:51:56 +03:00
Laurent Pinchart
dd84815d61 Documentation: Link to API section in Docs
The API belongs to the docs section. Link to it from docs.rst, and
remove the shortcut in the navigation bar as links to a placeholder
only.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
2019-10-23 17:41:09 +03:00
Laurent Pinchart
e42683b40d Documentation: Add placeholder for Doxygen-generated API documentation
Until we have better Sphinx + Doxygen integration, replace the relative
external link to the API documentation with a placeholder directory,
which will be populated with the Doxygen-generated doc when exporting
documentation to the website. This is needed as the Sphinx documentation
is exported to the root of the website, linking to ../api-html is thus
not possible.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Acked-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2019-01-11 17:17:22 +02:00