[v2,07/10] Documentation: Include API docs in the sphinx documentation
diff mbox series

Message ID 20250911230115.25335-8-laurent.pinchart@ideasonboard.com
State New
Headers show
Series
  • Documentation theming update
Related show

Commit Message

Laurent Pinchart Sept. 11, 2025, 11:01 p.m. UTC 
From: Stefan Klug <stefan.klug@ideasonboard.com>

This commit prepares the move of all the libcamera documetation to a
place separate from the website. This makes it easier to handle website
and docs separately.

The index is updated to mimic the structure currently available on the
website.

Signed-off-by: Stefan Klug <stefan.klug@ideasonboard.com>
---
Changes since v1:

- Split the build changes to a separate patch
---
 Documentation/index.rst        | 45 ++++++++++++++++++++--------------
 Documentation/introduction.rst |  6 -----
 2 files changed, 26 insertions(+), 25 deletions(-)

Patch
diff mbox series 

diff --git a/Documentation/index.rst b/Documentation/index.rst
index 251112fbdf5f..d55b5ff21464 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -4,28 +4,35 @@ 
 
 .. toctree::
    :maxdepth: 1
-   :caption: Contents:
+   :caption: For Users
 
-   Home <self>
-   Contribute <contributing>
-   Getting Started <getting-started>
-
-   Application Writer's Guide <guides/application-developer>
-   Camera Sensor Model <camera-sensor-model>
-   Environment variables <environment_variables>
+   Introduction <self>
    Feature Requirements <feature_requirements>
-   IPA Writer's guide <guides/ipa>
-   Lens driver requirements <lens_driver_requirements>
-   libcamera Architecture <libcamera_architecture>
-   Pipeline Handler Writer's Guide <guides/pipeline-handler>
+   Application Writer's Guide <guides/application-developer>
    Python Bindings <python-bindings>
-   Sensor driver requirements <sensor_driver_requirements>
-   SoftwareISP Benchmarking <software-isp-benchmarking>
-   Tracing guide <guides/tracing>
-
-   Design document: AE <design/ae>
+   Environment variables <environment_variables>
+   Public API <api-html/index>
 
 .. toctree::
-   :hidden:
+   :maxdepth: 1
+   :caption: For Developers
+
+   Contribute <contributing>
+   Getting Started <getting-started>
+   Camera Sensor Model <camera-sensor-model>
+   IPA Writer's guide <guides/ipa>
+   libcamera Architecture <libcamera_architecture>
+   Pipeline Handler Writer's Guide <guides/pipeline-handler>
+   SoftwareISP Benchmarking <software-isp-benchmarking>
+   Tracing guide <guides/tracing>
+   Design document: AE <design/ae>
+   Internal API <internal-api-html/index>
+
+.. toctree::
+   :maxdepth: 1
+   :caption: For System Integrators
+
+   Lens driver requirements <lens_driver_requirements>
+   Sensor driver requirements <sensor_driver_requirements>
+
 
-   introduction
diff --git a/Documentation/introduction.rst b/Documentation/introduction.rst
index 82aa11a30f33..d76cebd05ee1 100644
--- a/Documentation/introduction.rst
+++ b/Documentation/introduction.rst
@@ -6,12 +6,6 @@ 
 Introduction
 ************
 
-.. toctree::
-   :hidden:
-
-   API <api-html/index>
-   Internal API <internal-api-html/index>
-
 What is libcamera?
 ==================