[{"id":30857,"web_url":"https://patchwork.libcamera.org/comment/30857/","msgid":"<20240818230755.GE21937@pendragon.ideasonboard.com>","date":"2024-08-18T23:07:55","subject":"Re: [PATCH v2 7/7] Documentation: Rework index.rst","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Dan,\n\nThank you for the patch.\n\nOn Thu, Aug 15, 2024 at 09:29:44AM +0100, Daniel Scally wrote:\n> index.rst is the page that becomes index.html, but currently just has\n> some blurb. Although this page will only be seen if viewing the docs\n> as built from the libcamera tree it'd be better if it were more of an\n> introductory page. Include the content of docs.rst to improve it. As\n> we're no longer including the content from README.rst the labels that\n> enabled that can be dropped.\n> \n> With this change whether viewing the documentation as built in the\n> libcamera tree or on the Docs page of the website, the landing content\n> will be the same.\n\nThat's a nice improvement, thanks.\n\n> \n> The CSS for the documentation's theme currently hides the toctree from\n> the generated body in html, as it's already displayed on every page via\n> the theme's CSS. This change reorders the page such that the CSS that\n> hides the toctree no longer works - update the CSS to retain the\n> current behaviour.\n> \n> Signed-off-by: Daniel Scally \n\nReviewed-by: Laurent Pinchart \n\n> ---\n> Changes since v1:\n> \n> \t- Removed superfluous comments\n> \t- Expanded commit message\n> \n> Documentation/index.rst | 11 ++++++-----\n> Documentation/theme/static/css/theme.css | 2 +-\n> README.rst | 3 ---\n> 3 files changed, 7 insertions(+), 9 deletions(-)\n> \n> diff --git a/Documentation/index.rst b/Documentation/index.rst\n> index 6d7d2ca3..a27061aa 100644\n> --- a/Documentation/index.rst\n> +++ b/Documentation/index.rst\n> @@ -1,16 +1,12 @@\n> .. SPDX-License-Identifier: CC-BY-SA-4.0\n> \n> -.. Front page matter is defined in the project README file.\n> -.. include:: ../README.rst\n> - :start-after: .. section-begin-libcamera\n> - :end-before: .. section-end-libcamera\n> +.. include:: docs.rst\n> \n> .. toctree::\n> :maxdepth: 1\n> :caption: Contents:\n> \n> Home \n> - Docs \n> Contribute \n> Getting Started \n> \n> @@ -26,3 +22,8 @@\n> Sensor driver requirements \n> SoftwareISP Benchmarking \n> Tracing guide \n> +\n> +.. toctree::\n> + :hidden:\n> +\n> + docs\n> \\ No newline at end of file\n> diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css\n> index 2b1ed095..a6d43195 100644\n> --- a/Documentation/theme/static/css/theme.css\n> +++ b/Documentation/theme/static/css/theme.css\n> @@ -283,7 +283,7 @@ div#signature {\n> \tfont-size: 12px;\n> }\n> \n> -#libcamera div.toctree-wrapper {\n> +#licensing div.toctree-wrapper {\n> \theight: 0px;\n> \tmargin: 0px;\n> \tpadding: 0px;\n> diff --git a/README.rst b/README.rst\n> index 92f16502..4068c6cc 100644\n> --- a/README.rst\n> +++ b/README.rst\n> @@ -1,7 +1,5 @@\n> .. SPDX-License-Identifier: CC-BY-SA-4.0\n> \n> -.. section-begin-libcamera\n> -\n> ===========\n> libcamera\n> ===========\n> @@ -22,7 +20,6 @@ open-source-friendly while still protecting vendor core IP. libcamera was born\n> out of that collaboration and will offer modern camera support to Linux-based\n> systems, including traditional Linux distributions, ChromeOS and Android.\n> \n> -.. section-end-libcamera\n> .. section-begin-getting-started\n> \n> Getting Started","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 3A0BCBDB13\n\tfor ;\n\tSun, 18 Aug 2024 23:08:26 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 3B674633BD;\n\tMon, 19 Aug 2024 01:08:25 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 6D0E763382\n\tfor ;\n\tMon, 19 Aug 2024 01:08:23 +0200 (CEST)","from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi\n\t[81.175.209.231])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 5B865227;\n\tMon, 19 Aug 2024 01:07:22 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"G4BgCnPS\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1724022442;\n\tbh=wD8ecZlqrcLMwQbkuN9x7JBlZWZGcW7B0Jf0dvf5RF4=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=G4BgCnPSl6NoPCW8lXeerjb5+gsfj5V2aqbin5EchITmYKrx4sSuRFrnqZoFHmiLV\n\tvthjNNjPooNUZACmdkpgXB8TjfeBuUIw7ZD4Xre2m+1ip3pR89LalNNr0PO8ME0SBw\n\taLINEANmDxoHOiDrV54b6cU4idr6mObS/LtYoSY8=","Date":"Mon, 19 Aug 2024 02:07:55 +0300","From":"Laurent Pinchart ","To":"Daniel Scally ","Cc":"libcamera-devel@lists.libcamera.org","Subject":"Re: [PATCH v2 7/7] Documentation: Rework index.rst","Message-ID":"<20240818230755.GE21937@pendragon.ideasonboard.com>","References":"<20240815082944.170109-1-dan.scally@ideasonboard.com>\n\t<20240815082944.170109-8-dan.scally@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20240815082944.170109-8-dan.scally@ideasonboard.com>","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]