From patchwork Fri Aug 9 14:53:04 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Scally X-Patchwork-Id: 20868 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 1A0A7C32D5 for ; Fri, 9 Aug 2024 14:53:34 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 83552633C7; Fri, 9 Aug 2024 16:53:33 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="Bk6a69t/"; 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 A4489633BE for ; Fri, 9 Aug 2024 16:53:21 +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 5FAC0A38; Fri, 9 Aug 2024 16:52:27 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1723215147; bh=qohjoarJ54aX6yUKeVK3fr5RowKkwjxX/Y5j1TW8zM0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=Bk6a69t//PmH140FD59R5V3IHeNTh+vEq/1v/uMvG7LCy3SPEWsm/NudXlpufdHff V7/uuA78bUXwbAG/g0y2tm6jWK0jLqALdGLMF5VqFnuHmCfWpSHW6uelDd7+X/Prhx TB2hkNfH1LubvbFg6owVc0IP2H8YLvaxAYlEAlVQ= From: Daniel Scally To: libcamera-devel@lists.libcamera.org Cc: Daniel Scally Subject: [PATCH 7/7] Documentation: Rework index.rst Date: Fri, 9 Aug 2024 15:53:04 +0100 Message-Id: <20240809145304.537551-8-dan.scally@ideasonboard.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240809145304.537551-1-dan.scally@ideasonboard.com> References: <20240809145304.537551-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. 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 is updated so that section ID references still fix the right problem. Signed-off-by: Daniel Scally --- Documentation/index.rst | 10 ++++++---- Documentation/theme/static/css/theme.css | 2 +- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/Documentation/index.rst b/Documentation/index.rst index 6d7d2ca3..0fe10706 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -1,16 +1,13 @@ .. 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:: docs.rst .. toctree:: :maxdepth: 1 :caption: Contents: Home - Docs Contribute Getting Started @@ -26,3 +23,8 @@ Sensor driver requirements SoftwareISP Benchmarking Tracing guide + +.. toctree:: + :hidden: + + docs \ 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;