[libcamera-devel] [PATCH] Documentation: Add placeholder for Doxygen-generated API documentation
Laurent Pinchart
laurent.pinchart at ideasonboard.com
Fri Jan 11 15:38:24 CET 2019
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 at ideasonboard.com>
---
Documentation/api-html/index.rst | 4 ++++
Documentation/index.rst | 2 +-
2 files changed, 5 insertions(+), 1 deletion(-)
create mode 100644 Documentation/api-html/index.rst
diff --git a/Documentation/api-html/index.rst b/Documentation/api-html/index.rst
new file mode 100644
index 000000000000..dbaaad1552b6
--- /dev/null
+++ b/Documentation/api-html/index.rst
@@ -0,0 +1,4 @@
+API
+===
+
+:: Placeholder for Doxygen documentation
diff --git a/Documentation/index.rst b/Documentation/index.rst
index a87509c24275..e481f081f9a1 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -24,4 +24,4 @@ systems, including traditional Linux distributions, ChromeOS and Android.
Docs <docs>
Coding Style <coding-style>
Contribute <contributing>
- API <../api-html/index.html#://>
+ API <api-html/index>
--
Regards,
Laurent Pinchart
More information about the libcamera-devel
mailing list