From patchwork Mon Aug 19 16:09:14 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Scally X-Patchwork-Id: 20949 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 F0835BDB13 for ; Mon, 19 Aug 2024 16:09:39 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 6FCEE633C3; Mon, 19 Aug 2024 18:09:38 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="UiytlbLM"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id E50EB633B3 for ; Mon, 19 Aug 2024 18:09:35 +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 41AA05A5; Mon, 19 Aug 2024 18:08:34 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1724083714; bh=XrXqDbJt1vyIG+pQGRgSpXzs0rT+kVQblLNa/ar3BuA=; h=From:To:Cc:Subject:Date:From; b=UiytlbLM5MCQIMJxKr+sZuX3l0MSOVE8mcWdXIf2tdFyH8IdbgLJwWZtweg5PvQeY 7M2OQqtOkYSdEboAP7lfP7fjUUE6FsTr5nBTdf6iM5IEhHQhBHhP96DlOW/VXvWZ76 1dmku10sp4R/TeLb/74bB6PY1kVtPq62aBYDQFxA= From: Daniel Scally To: libcamera-devel@lists.libcamera.org Cc: Daniel Scally Subject: [PATCH v3 0/7] Documentation improvements Date: Mon, 19 Aug 2024 17:09:14 +0100 Message-Id: <20240819160921.468981-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 (7): 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/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 | 28 ++ Documentation/environment_variables.rst | 2 + Documentation/feature_requirements.rst | 145 +++++++ 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/introduction.rst | 226 ++++++++++ Documentation/lens_driver_requirements.rst | 2 + Documentation/libcamera_architecture.rst | 155 +++++++ Documentation/mali-c55.dot | 23 + 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 - 25 files changed, 634 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/introduction.rst create mode 100644 Documentation/libcamera_architecture.rst create mode 100644 Documentation/mali-c55.dot