From patchwork Thu Aug 15 08:29:37 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Scally X-Patchwork-Id: 20932 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 C46FEC323E for ; Thu, 15 Aug 2024 08:30:06 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 679E5633C6; Thu, 15 Aug 2024 10:30:05 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="QOLuEArb"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 8A4B563393 for ; Thu, 15 Aug 2024 10:30:03 +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 F16C1A34; Thu, 15 Aug 2024 10:29:04 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1723710545; bh=8bZGAnkYx+LnjkCdjWZJ7aUFwFQVCed8rS0vsKTCD+g=; h=From:To:Cc:Subject:Date:From; b=QOLuEArbKvOPuuI9venXwMuaO7A2U8eHa5LdBq6OxDiHtHh4ewmMmWbCy/K0gsOQS mKL3J2/rggB6Br4nNjC8rAta7zffb2xxlfsCA2eZMtwxVvG4vLfdQecqpeBzqj3CNW PtiDzDL36+cgxrvAv5wltGy2PfJqm4HnXKdWSLcU= From: Daniel Scally To: libcamera-devel@lists.libcamera.org Cc: Daniel Scally Subject: [PATCH v2 0/7] Documentation improvements Date: Thu, 15 Aug 2024 09:29:37 +0100 Message-Id: <20240815082944.170109-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 libcamera architecture details Documentation: Breakout docs.rst Documentation: Remove camera stack from introduction.rst Documentation: Expand introductory content on docs.rst Documentation: Rework index.rst Documentation/c55.svg | 175 ++++++ Documentation/camera-sensor-model.rst | 2 + Documentation/camera_stack.rst | 109 ++++ Documentation/code-of-conduct.rst | 2 + Documentation/coding-style.rst | 2 + Documentation/conf.py | 7 +- Documentation/docs.rst | 544 ++++++++---------- 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/lens_driver_requirements.rst | 2 + Documentation/meson.build | 4 +- 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 - 24 files changed, 739 insertions(+), 650 deletions(-) create mode 100644 Documentation/c55.svg create mode 100644 Documentation/camera_stack.rst create mode 100644 Documentation/documentation-contents.rst create mode 100644 Documentation/feature_requirements.rst delete mode 100644 Documentation/guides/introduction.rst