[{"id":30871,"web_url":"https://patchwork.libcamera.org/comment/30871/","msgid":"<20240820132503.GC7478@pendragon.ideasonboard.com>","date":"2024-08-20T13:25:03","subject":"Re: [PATCH v4 9/9] Documentation: Reformat\n\tdocumentation_contents.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 Tue, Aug 20, 2024 at 02:07:40PM +0100, Daniel Scally wrote:\n> Now that documentation_contents.rst serves as a navbar for the docs\n> pages on the website, reformat it to present the links in a more\n> logical order. The list is split into three sections for Users,\n> Developers and System Integrators, with a slight break between\n> each section and a header above the links.\n> \n> Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>\n> ---\n> Changes since v3:\n> \n> \t- New patch\n> \n>  Documentation/documentation-contents.rst | 26 +++++++++++++++---------\n>  1 file changed, 16 insertions(+), 10 deletions(-)\n> \n> diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst\n> index 912b13f3..4e7d1af9 100644\n> --- a/Documentation/documentation-contents.rst\n> +++ b/Documentation/documentation-contents.rst\n> @@ -2,22 +2,28 @@\n>  \n>  .. container:: documentation-nav\n>  \n> -   * :doc:`/api-html/index`\n> -   * :doc:`/internal-api-html/index`\n> -   * :doc:`/camera-sensor-model`\n> -   * :doc:`/code-of-conduct`\n> -   * :doc:`/coding-style`\n> -   * :doc:`/environment_variables`\n> +   * **Documentation for Users**\n> +   * :doc:`Introduction </introduction>`\n>     * :doc:`/feature_requirements`\n>     * :doc:`/guides/application-developer`\n> -   * :doc:`/guides/ipa`\n> +   * :doc:`/python-bindings`\n> +   * :doc:`/environment_variables`\n> +   * :doc:`API Reference </api-html/index>`\n> +   * :doc:`/code-of-conduct`\n> +   * |\n> +   * **Documentation for Developers**\n\nInstead of adding an empty entry and formatting the section headers with\n**, I wonder if we could give them a class and handle the formatting in\nCSS. This can be done on top, so\n\nReviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\n> +   * :doc:`/libcamera_architecture`\n>     * :doc:`/guides/pipeline-handler`\n> +   * :doc:`/guides/ipa`\n> +   * :doc:`/camera-sensor-model`\n>     * :doc:`/guides/tracing`\n> +   * :doc:`/software-isp-benchmarking`\n> +   * :doc:`/coding-style`\n> +   * :doc:`Internal API Reference </internal-api-html/index>`\n> +   * |\n> +   * **Documentation for System Integrators**\n>     * :doc:`/lens_driver_requirements`\n> -   * :doc:`/libcamera_architecture`\n> -   * :doc:`/python-bindings`\n>     * :doc:`/sensor_driver_requirements`\n> -   * :doc:`/software-isp-benchmarking`\n>  \n>  ..\n>     The following directive adds the \"documentation\" class to all of the pages","headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","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 12E90BDB13\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 20 Aug 2024 13:25:09 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 31167633CE;\n\tTue, 20 Aug 2024 15:25:08 +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 C333C633B2\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 20 Aug 2024 15:25:05 +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 58B106BE;\n\tTue, 20 Aug 2024 15:24:03 +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=\"XXUNInlm\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1724160243;\n\tbh=vbzFH5ddj/OmUw7mCmUeavNCcPPD/tj6Defzca0tpXM=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=XXUNInlmelGMdYt3n9OqtRg1lcm/XhWCx+PuKVTErTY7m1x4Wm+am4UjQZmRynCu0\n\t86bhHbb4IHfrLXWXmGgYQk6Vm8+fRDg3jIEZPOFH9/S4D6yOPUoUK+ZjI7GrnX5dER\n\t7FvHJ6nLmnKHo02yZh5BCXVEb3wXdfNjUS33RV7U=","Date":"Tue, 20 Aug 2024 16:25:03 +0300","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"Daniel Scally <dan.scally@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org","Subject":"Re: [PATCH v4 9/9] Documentation: Reformat\n\tdocumentation_contents.rst","Message-ID":"<20240820132503.GC7478@pendragon.ideasonboard.com>","References":"<20240820130740.568243-1-dan.scally@ideasonboard.com>\n\t<20240820130740.568243-10-dan.scally@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20240820130740.568243-10-dan.scally@ideasonboard.com>","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}},{"id":30872,"web_url":"https://patchwork.libcamera.org/comment/30872/","msgid":"<6e0c66a4-9c59-4d73-9585-bf8d01609018@ideasonboard.com>","date":"2024-08-20T13:28:27","subject":"Re: [PATCH v4 9/9] Documentation: Reformat\n\tdocumentation_contents.rst","submitter":{"id":156,"url":"https://patchwork.libcamera.org/api/people/156/","name":"Dan Scally","email":"dan.scally@ideasonboard.com"},"content":"Hi Laurent\n\nOn 20/08/2024 14:25, Laurent Pinchart wrote:\n> Hi Dan,\n>\n> Thank you for the patch.\n>\n> On Tue, Aug 20, 2024 at 02:07:40PM +0100, Daniel Scally wrote:\n>> Now that documentation_contents.rst serves as a navbar for the docs\n>> pages on the website, reformat it to present the links in a more\n>> logical order. The list is split into three sections for Users,\n>> Developers and System Integrators, with a slight break between\n>> each section and a header above the links.\n>>\n>> Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>\n>> ---\n>> Changes since v3:\n>>\n>> \t- New patch\n>>\n>>   Documentation/documentation-contents.rst | 26 +++++++++++++++---------\n>>   1 file changed, 16 insertions(+), 10 deletions(-)\n>>\n>> diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst\n>> index 912b13f3..4e7d1af9 100644\n>> --- a/Documentation/documentation-contents.rst\n>> +++ b/Documentation/documentation-contents.rst\n>> @@ -2,22 +2,28 @@\n>>   \n>>   .. container:: documentation-nav\n>>   \n>> -   * :doc:`/api-html/index`\n>> -   * :doc:`/internal-api-html/index`\n>> -   * :doc:`/camera-sensor-model`\n>> -   * :doc:`/code-of-conduct`\n>> -   * :doc:`/coding-style`\n>> -   * :doc:`/environment_variables`\n>> +   * **Documentation for Users**\n>> +   * :doc:`Introduction </introduction>`\n>>      * :doc:`/feature_requirements`\n>>      * :doc:`/guides/application-developer`\n>> -   * :doc:`/guides/ipa`\n>> +   * :doc:`/python-bindings`\n>> +   * :doc:`/environment_variables`\n>> +   * :doc:`API Reference </api-html/index>`\n>> +   * :doc:`/code-of-conduct`\n>> +   * |\n>> +   * **Documentation for Developers**\n> Instead of adding an empty entry and formatting the section headers with\n> **, I wonder if we could give them a class and handle the formatting in\n> CSS.\n\nWith\n\n.. role:: documentation-nav-header\n\n    :class: documentation-nav-header\n\n\nFollowed by something like\n\n\n* :documentation-nav-header:`Documentation for Users`\n\n\nWhich then wraps the header in a new span with that class. I did start down that route but it seemed \nmuch clunkier, but perhaps it can be made to work nicely with more effort\n\n> This can be done on top, so\n>\n> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\n\nThanks\n\n>> +   * :doc:`/libcamera_architecture`\n>>      * :doc:`/guides/pipeline-handler`\n>> +   * :doc:`/guides/ipa`\n>> +   * :doc:`/camera-sensor-model`\n>>      * :doc:`/guides/tracing`\n>> +   * :doc:`/software-isp-benchmarking`\n>> +   * :doc:`/coding-style`\n>> +   * :doc:`Internal API Reference </internal-api-html/index>`\n>> +   * |\n>> +   * **Documentation for System Integrators**\n>>      * :doc:`/lens_driver_requirements`\n>> -   * :doc:`/libcamera_architecture`\n>> -   * :doc:`/python-bindings`\n>>      * :doc:`/sensor_driver_requirements`\n>> -   * :doc:`/software-isp-benchmarking`\n>>   \n>>   ..\n>>      The following directive adds the \"documentation\" class to all of the pages","headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","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 0A00EBDB13\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 20 Aug 2024 13:28:33 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id A670D633D0;\n\tTue, 20 Aug 2024 15:28:31 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 8CF50633B2\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 20 Aug 2024 15:28:30 +0200 (CEST)","from [192.168.0.43]\n\t(cpc141996-chfd3-2-0-cust928.12-3.cable.virginm.net [86.13.91.161])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 5FEC24CC;\n\tTue, 20 Aug 2024 15:27:28 +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=\"fxj0SgzA\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1724160448;\n\tbh=IBVZM583xbPVG1s3YiXLTobjQieaCY7q8sN43vTubC8=;\n\th=Date:Subject:To:Cc:References:From:In-Reply-To:From;\n\tb=fxj0SgzA0h/YmJ9wrD52YguaNh7eyQ58hPhp8i+7ye6tIcwbpnnQ+lvPfk8zJe3p6\n\to43AdO8V0xyvYVyLcmaB/7yhEGGjnW96oCWNuxiwX3OhicIzZgCFmE/WiUPwXMV+/o\n\td2GAK3nW/bs1A8PiaIcJjsL4OhIqwwD48X7lQc6I=","Message-ID":"<6e0c66a4-9c59-4d73-9585-bf8d01609018@ideasonboard.com>","Date":"Tue, 20 Aug 2024 14:28:27 +0100","MIME-Version":"1.0","User-Agent":"Mozilla Thunderbird","Subject":"Re: [PATCH v4 9/9] Documentation: Reformat\n\tdocumentation_contents.rst","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org","References":"<20240820130740.568243-1-dan.scally@ideasonboard.com>\n\t<20240820130740.568243-10-dan.scally@ideasonboard.com>\n\t<20240820132503.GC7478@pendragon.ideasonboard.com>","Content-Language":"en-US","From":"Dan Scally <dan.scally@ideasonboard.com>","Autocrypt":"addr=dan.scally@ideasonboard.com; keydata=\n\txsFNBGLydlEBEADa5O2s0AbUguprfvXOQun/0a8y2Vk6BqkQALgeD6KnXSWwaoCULp18etYW\n\tB31bfgrdphXQ5kUQibB0ADK8DERB4wrzrUb5CMxLBFE7mQty+v5NsP0OFNK9XTaAOcmD+Ove\n\teIjYvqurAaro91jrRVrS1gBRxIFqyPgNvwwL+alMZhn3/2jU2uvBmuRrgnc/e9cHKiuT3Dtq\n\tMHGPKL2m+plk+7tjMoQFfexoQ1JKugHAjxAhJfrkXh6uS6rc01bYCyo7ybzg53m1HLFJdNGX\n\tsUKR+dQpBs3SY4s66tc1sREJqdYyTsSZf80HjIeJjU/hRunRo4NjRIJwhvnK1GyjOvvuCKVU\n\tRWpY8dNjNu5OeAfdrlvFJOxIE9M8JuYCQTMULqd1NuzbpFMjc9524U3Cngs589T7qUMPb1H1\n\tNTA81LmtJ6Y+IV5/kiTUANflpzBwhu18Ok7kGyCq2a2jsOcVmk8gZNs04gyjuj8JziYwwLbf\n\tvzABwpFVcS8aR+nHIZV1HtOzyw8CsL8OySc3K9y+Y0NRpziMRvutrppzgyMb9V+N31mK9Mxl\n\t1YkgaTl4ciNWpdfUe0yxH03OCuHi3922qhPLF4XX5LN+NaVw5Xz2o3eeWklXdouxwV7QlN33\n\tu4+u2FWzKxDqO6WLQGjxPE0mVB4Gh5Pa1Vb0ct9Ctg0qElvtGQARAQABzShEYW4gU2NhbGx5\n\tIDxkYW4uc2NhbGx5QGlkZWFzb25ib2FyZC5jb20+wsGNBBMBCAA3FiEEsdtt8OWP7+8SNfQe\n\tkiQuh/L+GMQFAmLydlIFCQWjmoACGwMECwkIBwUVCAkKCwUWAgMBAAAKCRCSJC6H8v4YxDI2\n\tEAC2Gz0iyaXJkPInyshrREEWbo0CA6v5KKf3I/HlMPqkZ48bmGoYm4mEQGFWZJAT3K4ir8bg\n\tcEfs9V54gpbrZvdwS4abXbUK4WjKwEs8HK3XJv1WXUN2bsz5oEJWZUImh9gD3naiLLI9QMMm\n\tw/aZkT+NbN5/2KvChRWhdcha7+2Te4foOY66nIM+pw2FZM6zIkInLLUik2zXOhaZtqdeJZQi\n\tHSPU9xu7TRYN4cvdZAnSpG7gQqmLm5/uGZN1/sB3kHTustQtSXKMaIcD/DMNI3JN/t+RJVS7\n\tc0Jh/ThzTmhHyhxx3DRnDIy7kwMI4CFvmhkVC2uNs9kWsj1DuX5kt8513mvfw2OcX9UnNKmZ\n\tnhNCuF6DxVrL8wjOPuIpiEj3V+K7DFF1Cxw1/yrLs8dYdYh8T8vCY2CHBMsqpESROnTazboh\n\tAiQ2xMN1cyXtX11Qwqm5U3sykpLbx2BcmUUUEAKNsM//Zn81QXKG8vOx0ZdMfnzsCaCzt8f6\n\t9dcDBBI3tJ0BI9ByiocqUoL6759LM8qm18x3FYlxvuOs4wSGPfRVaA4yh0pgI+ModVC2Pu3y\n\tejE/IxeatGqJHh6Y+iJzskdi27uFkRixl7YJZvPJAbEn7kzSi98u/5ReEA8Qhc8KO/B7wprj\n\txjNMZNYd0Eth8+WkixHYj752NT5qshKJXcyUU87BTQRi8nZSARAAx0BJayh1Fhwbf4zoY56x\n\txHEpT6DwdTAYAetd3yiKClLVJadYxOpuqyWa1bdfQWPb+h4MeXbWw/53PBgn7gI2EA7ebIRC\n\tPJJhAIkeym7hHZoxqDQTGDJjxFEL11qF+U3rhWiL2Zt0Pl+zFq0eWYYVNiXjsIS4FI2+4m16\n\ttPbDWZFJnSZ828VGtRDQdhXfx3zyVX21lVx1bX4/OZvIET7sVUufkE4hrbqrrufre7wsjD1t\n\t8MQKSapVrr1RltpzPpScdoxknOSBRwOvpp57pJJe5A0L7+WxJ+vQoQXj0j+5tmIWOAV1qBQp\n\thyoyUk9JpPfntk2EKnZHWaApFp5TcL6c5LhUvV7F6XwOjGPuGlZQCWXee9dr7zym8iR3irWT\n\t+49bIh5PMlqSLXJDYbuyFQHFxoiNdVvvf7etvGfqFYVMPVjipqfEQ38ST2nkzx+KBICz7uwj\n\tJwLBdTXzGFKHQNckGMl7F5QdO/35An/QcxBnHVMXqaSd12tkJmoRVWduwuuoFfkTY5mUV3uX\n\txGj3iVCK4V+ezOYA7c2YolfRCNMTza6vcK/P4tDjjsyBBZrCCzhBvd4VVsnnlZhVaIxoky4K\n\taL+AP+zcQrUZmXmgZjXOLryGnsaeoVrIFyrU6ly90s1y3KLoPsDaTBMtnOdwxPmo1xisH8oL\n\ta/VRgpFBfojLPxMAEQEAAcLBfAQYAQgAJhYhBLHbbfDlj+/vEjX0HpIkLofy/hjEBQJi8nZT\n\tBQkFo5qAAhsMAAoJEJIkLofy/hjEXPcQAMIPNqiWiz/HKu9W4QIf1OMUpKn3YkVIj3p3gvfM\n\tRes4fGX94Ji599uLNrPoxKyaytC4R6BTxVriTJjWK8mbo9jZIRM4vkwkZZ2bu98EweSucxbp\n\tvjESsvMXGgxniqV/RQ/3T7LABYRoIUutARYq58p5HwSP0frF0fdFHYdTa2g7MYZl1ur2JzOC\n\tFHRpGadlNzKDE3fEdoMobxHB3Lm6FDml5GyBAA8+dQYVI0oDwJ3gpZPZ0J5Vx9RbqXe8RDuR\n\tdu90hvCJkq7/tzSQ0GeD3BwXb9/R/A4dVXhaDd91Q1qQXidI+2jwhx8iqiYxbT+DoAUkQRQy\n\txBtoCM1CxH7u45URUgD//fxYr3D4B1SlonA6vdaEdHZOGwECnDpTxecENMbz/Bx7qfrmd901\n\tD+N9SjIwrbVhhSyUXYnSUb8F+9g2RDY42Sk7GcYxIeON4VzKqWM7hpkXZ47pkK0YodO+dRKM\n\tyMcoUWrTK0Uz6UzUGKoJVbxmSW/EJLEGoI5p3NWxWtScEVv8mO49gqQdrRIOheZycDmHnItt\n\t9Qjv00uFhEwv2YfiyGk6iGF2W40s2pH2t6oeuGgmiZ7g6d0MEK8Ql/4zPItvr1c1rpwpXUC1\n\tu1kQWgtnNjFHX3KiYdqjcZeRBiry1X0zY+4Y24wUU0KsEewJwjhmCKAsju1RpdlPg2kC","In-Reply-To":"<20240820132503.GC7478@pendragon.ideasonboard.com>","Content-Type":"text/plain; charset=UTF-8; format=flowed","Content-Transfer-Encoding":"8bit","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}}]