From patchwork Tue Aug 20 13:07:31 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Scally X-Patchwork-Id: 20957 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 1BFEDBDB13 for ; Tue, 20 Aug 2024 13:07:59 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 31E74633D8; Tue, 20 Aug 2024 15:07:57 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="gCr2DqMQ"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id C716B633B2 for ; Tue, 20 Aug 2024 15:07:53 +0200 (CEST) Received: from mail.ideasonboard.com (cpc141996-chfd3-2-0-cust928.12-3.cable.virginm.net [86.13.91.161]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 908934CC; Tue, 20 Aug 2024 15:06:51 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1724159211; bh=HdZMPRMWuB9uuB+/4vi6xaS+115S1qgMr3dmbgT/ytI=; h=From:To:Cc:Subject:Date:From; b=gCr2DqMQqc9Y1xxfWhAPqRT+5ujzxpkYPU3c6H8aJAIdXJCsdEbS5Liv53exUZG2j i9hsPwsBGt5+y2AZGdppA6+shMORjCNPuKJEK8PqXHnv/bVxfj0X1qzoRDOYr9Ok14 ovAUpFJik3zozBADK1+KMhup4ZNDNB22gLiDdVPM= From: Daniel Scally To: libcamera-devel@lists.libcamera.org Cc: Daniel Scally Subject: [PATCH v4 0/9] Documentation improvements Date: Tue, 20 Aug 2024 14:07:31 +0100 Message-Id: <20240820130740.568243-1-dan.scally@ideasonboard.com> X-Mailer: git-send-email 2.34.1 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" Hi All This series aims to improve the Documentation .rst files within libcamera so we can integrate them more easily into the libcamera website. The goal is to add a structure that can replace the sidebar on the Docs page [1] with links to all of the Documentation pages within the libcamera tree, especially the guides. To do this properly some tidying up and reformating of the existing Documentation is done and the introductory content from guides/introduction.rst moved to the docs.rst page (and expanded) - this allows us to have the docs page on the website and the index page in Documentation built within the libcamera tree display the same content and links. Thanks Dan [1] https://libcamera.org/docs.html Daniel Scally (9): Documentation: Add documentation-contents.rst Documentation: Alphabetise the Documentation toctree Documentation: Synchronise camera stack details Documentation: Breakout docs.rst Documentation: Remove libcamera architecture from introduction.rst Documentation: Rework docs.rst into introduction.rst Documentation: Rework index.rst Documentation: Add internal-api-html placeholder Documentation: Reformat documentation_contents.rst Documentation/camera-sensor-model.rst | 2 + Documentation/code-of-conduct.rst | 2 + Documentation/coding-style.rst | 2 + Documentation/conf.py | 10 +- Documentation/docs.rst | 400 ------------------ Documentation/documentation-contents.rst | 35 ++ Documentation/environment_variables.rst | 2 + Documentation/feature_requirements.rst | 150 +++++++ Documentation/getting-started.rst | 1 + .../guides/application-developer.rst | 2 + Documentation/guides/introduction.rst | 319 -------------- Documentation/guides/ipa.rst | 2 + Documentation/guides/pipeline-handler.rst | 2 + Documentation/guides/tracing.rst | 2 + Documentation/index.rst | 24 +- Documentation/internal-api-html/index.rst | 8 + Documentation/introduction.rst | 227 ++++++++++ Documentation/lens_driver_requirements.rst | 2 + Documentation/libcamera_architecture.rst | 168 ++++++++ Documentation/mali-c55.dot | 25 ++ Documentation/meson.build | 7 +- Documentation/python-bindings.rst | 2 + Documentation/sensor_driver_requirements.rst | 2 + Documentation/software-isp-benchmarking.rst | 2 + Documentation/theme/static/css/theme.css | 6 +- README.rst | 3 - 26 files changed, 670 insertions(+), 737 deletions(-) delete mode 100644 Documentation/docs.rst create mode 100644 Documentation/documentation-contents.rst create mode 100644 Documentation/feature_requirements.rst delete mode 100644 Documentation/guides/introduction.rst create mode 100644 Documentation/internal-api-html/index.rst create mode 100644 Documentation/introduction.rst create mode 100644 Documentation/libcamera_architecture.rst create mode 100644 Documentation/mali-c55.dot