From patchwork Tue Aug 20 13:07:38 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Scally X-Patchwork-Id: 20964 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 0CE8AC32A9 for ; Tue, 20 Aug 2024 13:08:17 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 3D23F633DC; Tue, 20 Aug 2024 15:08:12 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="qHIw8UJD"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id CB7CE633D3 for ; Tue, 20 Aug 2024 15:07:55 +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 C2CA04CC; Tue, 20 Aug 2024 15:06:53 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1724159213; bh=wEaFoGd8ZB0Af32oF35VqVMyb+ah/4RDg17sJePlZH4=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=qHIw8UJDHIYu0tKJmxtD5hC5+e48ARsEcQrcOr/VKmE+04sMf8vbPGI2JUnvdo/YH cuOhmqXKvVLcdMk7u+S/8U8VXAyFBWC2NI42fNF7+N59w45P2gTMr2Xq4jyObg4QF+ XicLkUpC9zYws7TNvaGL2VppZP7e6YOk/CkLXOsg= From: Daniel Scally To: libcamera-devel@lists.libcamera.org Cc: Daniel Scally , Laurent Pinchart Subject: [PATCH v4 7/9] Documentation: Rework index.rst Date: Tue, 20 Aug 2024 14:07:38 +0100 Message-Id: <20240820130740.568243-8-dan.scally@ideasonboard.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240820130740.568243-1-dan.scally@ideasonboard.com> References: <20240820130740.568243-1-dan.scally@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" index.rst is the page that becomes index.html, but currently just has some blurb. Although this page will only be seen if viewing the docs as built from the libcamera tree it'd be better if it were more of an introductory page. Include the content of docs.rst to improve it. As we're no longer including the content from README.rst the labels that enabled that can be dropped. With this change whether viewing the documentation as built in the libcamera tree or on the Docs page of the website, the landing content will be the same. The CSS for the documentation's theme currently hides the toctree from the generated body in html, as it's already displayed on every page via the theme's CSS. This change reorders the page such that the CSS that hides the toctree no longer works - update the CSS to retain the current behaviour. Reviewed-by: Laurent Pinchart Signed-off-by: Daniel Scally --- Changes since v3: - None Changes since v2: - None Changes since v1: - Removed superfluous comments - Expanded commit message Documentation/index.rst | 11 ++++++----- Documentation/theme/static/css/theme.css | 2 +- README.rst | 3 --- 3 files changed, 7 insertions(+), 9 deletions(-) diff --git a/Documentation/index.rst b/Documentation/index.rst index 3a790352..bea40660 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -1,16 +1,12 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. Front page matter is defined in the project README file. -.. include:: ../README.rst - :start-after: .. section-begin-libcamera - :end-before: .. section-end-libcamera +.. include:: introduction.rst .. toctree:: :maxdepth: 1 :caption: Contents: Home - Introduction Contribute Getting Started @@ -26,3 +22,8 @@ Sensor driver requirements SoftwareISP Benchmarking Tracing guide + +.. toctree:: + :hidden: + + introduction \ No newline at end of file diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css index 2b1ed095..a6d43195 100644 --- a/Documentation/theme/static/css/theme.css +++ b/Documentation/theme/static/css/theme.css @@ -283,7 +283,7 @@ div#signature { font-size: 12px; } -#libcamera div.toctree-wrapper { +#licensing div.toctree-wrapper { height: 0px; margin: 0px; padding: 0px; diff --git a/README.rst b/README.rst index 92f16502..4068c6cc 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. section-begin-libcamera - =========== libcamera =========== @@ -22,7 +20,6 @@ open-source-friendly while still protecting vendor core IP. libcamera was born out of that collaboration and will offer modern camera support to Linux-based systems, including traditional Linux distributions, ChromeOS and Android. -.. section-end-libcamera .. section-begin-getting-started Getting Started