From patchwork Thu Sep 11 23:01:08 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 24336 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 1E133C324E for ; Thu, 11 Sep 2025 23:02:00 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 7A75D69386; Fri, 12 Sep 2025 01:01:59 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="R8/PC+44"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id AA36A6937D for ; Fri, 12 Sep 2025 01:01:54 +0200 (CEST) Received: from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi [81.175.209.231]) by perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id D13DB4579; Fri, 12 Sep 2025 01:00:39 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1757631640; bh=TIwzx0fTJhFHyjo1d7irOFK0sIoWXLuWYK5eAH/Oklc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=R8/PC+44CzftpQy3a6qyQd7swyp/ErL8qPyqtrwOA1GznNABI5pI45YMKF+90hOpP F0UW9mslQFb4nvSp/qFD8JfTpNBFK+2tU40+auuVdW73fwD8cUvEIsJXW5RJwaee6B jujkO3vluCcuHtwVSvaDOFbuIn937WZb7IeHuErg= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Cc: Stefan Klug Subject: [PATCH v2 07/10] Documentation: Include API docs in the sphinx documentation Date: Fri, 12 Sep 2025 02:01:08 +0300 Message-ID: <20250911230115.25335-8-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.49.1 In-Reply-To: <20250911230115.25335-1-laurent.pinchart@ideasonboard.com> References: <20250911230115.25335-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" From: Stefan Klug 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 --- 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(-) 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 - Contribute - Getting Started - - Application Writer's Guide - Camera Sensor Model - Environment variables + Introduction Feature Requirements - IPA Writer's guide - Lens driver requirements - libcamera Architecture - Pipeline Handler Writer's Guide + Application Writer's Guide Python Bindings - Sensor driver requirements - SoftwareISP Benchmarking - Tracing guide - - Design document: AE + Environment variables + Public API .. toctree:: - :hidden: + :maxdepth: 1 + :caption: For Developers + + Contribute + Getting Started + Camera Sensor Model + IPA Writer's guide + libcamera Architecture + Pipeline Handler Writer's Guide + SoftwareISP Benchmarking + Tracing guide + Design document: AE + Internal API + +.. toctree:: + :maxdepth: 1 + :caption: For System Integrators + + Lens 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 - Internal API - What is libcamera? ==================