[{"id":30868,"web_url":"https://patchwork.libcamera.org/comment/30868/","msgid":"<nxbnj6qmcqmojyhms3gnrzifgozhrebt4xwnci4hahpfaxvxvj@4boy6buwzbu3>","date":"2024-08-20T08:06:24","subject":"Re: [PATCH v3 1/7] Documentation: Add documentation-contents.rst","submitter":{"id":184,"url":"https://patchwork.libcamera.org/api/people/184/","name":"Stefan Klug","email":"stefan.klug@ideasonboard.com"},"content":"Hi Dan,\n\nThank you for the patch.\n\nOn Mon, Aug 19, 2024 at 05:09:15PM +0100, Daniel Scally wrote:\n> Add a new .rst file referencing the documentation contents. This file\n> is then included in each documentation page so that we can enhance\n> the Documentation pages on the libcamera website using it. As we do\n> not want the appearance of the libcamera in-tree Documentation to\n> change just yet, disable the new class using the sphinx theme's CSS.\n> \n> To facilitate easier distinguishing between \"normal\" and\n> documentation pages on the website we want to add a \"documentation\"\n> class to the content of all such pages. Since this new file will be\n> included on each documentation page it is convenient to add the new\n> directive here - do so. As the website uses different CSS to\n> libcamera, move the contents on docs.rst a little so that the\n> directive at the end of the contents block applies correctly.\n\nI struggle a bit with adding the documentation-contents.rst to every\npage even though it is theoretically a property if the \"website-theme\".\nI didn't try it out, but would it be possible to set that in the config\nusing rs_prolog? (See\nhttps://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_prolog)\n\nconfig.py:\nrst_prolog = \"\"\"\n.. include:: documentation-contents.rst\n\"\"\"\n\nThis way we could keep the website specifics out of the content pages\n(as far as possible) and maybe switch between website and libcamera\nbuild using sphinx-build -c ...\n\n\nBest regards,\nStefan\n\n> \n> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>\n> ---\n> Changes since v2:\n> \n> \t- Spaces instead of tabs in meson.build\n> \n> changes since v1:\n> \n> \t- Formatting\n> \t- Properly added the new file to meson's list of docs_sources\n> \t- Commented the inclusion of the rst-class directive at the end of the\n> \t  new file\n> \n>  Documentation/camera-sensor-model.rst         |  2 ++\n>  Documentation/code-of-conduct.rst             |  2 ++\n>  Documentation/coding-style.rst                |  2 ++\n>  Documentation/conf.py                         |  7 ++++-\n>  Documentation/docs.rst                        |  2 ++\n>  Documentation/documentation-contents.rst      | 27 +++++++++++++++++++\n>  Documentation/environment_variables.rst       |  2 ++\n>  Documentation/getting-started.rst             |  1 +\n>  .../guides/application-developer.rst          |  2 ++\n>  Documentation/guides/introduction.rst         |  2 ++\n>  Documentation/guides/ipa.rst                  |  2 ++\n>  Documentation/guides/pipeline-handler.rst     |  2 ++\n>  Documentation/guides/tracing.rst              |  2 ++\n>  Documentation/lens_driver_requirements.rst    |  2 ++\n>  Documentation/meson.build                     |  1 +\n>  Documentation/python-bindings.rst             |  2 ++\n>  Documentation/sensor_driver_requirements.rst  |  2 ++\n>  Documentation/software-isp-benchmarking.rst   |  2 ++\n>  Documentation/theme/static/css/theme.css      |  4 +++\n>  19 files changed, 67 insertions(+), 1 deletion(-)\n>  create mode 100644 Documentation/documentation-contents.rst\n> \n> diff --git a/Documentation/camera-sensor-model.rst b/Documentation/camera-sensor-model.rst\n> index b66c880a..87a25bf4 100644\n> --- a/Documentation/camera-sensor-model.rst\n> +++ b/Documentation/camera-sensor-model.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> +.. include:: documentation-contents.rst\n> +\n>  .. _camera-sensor-model:\n>  \n>  .. todo: Move to Doxygen-generated documentation\n> diff --git a/Documentation/code-of-conduct.rst b/Documentation/code-of-conduct.rst\n> index 38b7d7ad..0edd1e99 100644\n> --- a/Documentation/code-of-conduct.rst\n> +++ b/Documentation/code-of-conduct.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-4.0\n>  \n> +.. include:: documentation-contents.rst\n> +\n>  .. _code-of-conduct:\n>  \n>  Contributor Covenant Code of Conduct\n> diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst\n> index 3352b75c..6ac3a4a0 100644\n> --- a/Documentation/coding-style.rst\n> +++ b/Documentation/coding-style.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> +.. include:: documentation-contents.rst\n> +\n>  .. _coding-style-guidelines:\n>  \n>  Coding Style Guidelines\n> diff --git a/Documentation/conf.py b/Documentation/conf.py\n> index 7eeea7f3..325f2759 100644\n> --- a/Documentation/conf.py\n> +++ b/Documentation/conf.py\n> @@ -61,7 +61,12 @@ language = 'en'\n>  # List of patterns, relative to source directory, that match files and\n>  # directories to ignore when looking for source files.\n>  # This pattern also affects html_static_path and html_extra_path.\n> -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']\n> +exclude_patterns = [\n> +    '_build',\n> +    'Thumbs.db',\n> +    '.DS_Store',\n> +    'documentation-contents.rst',\n> +]\n>  \n>  # The name of the Pygments (syntax highlighting) style to use.\n>  pygments_style = None\n> diff --git a/Documentation/docs.rst b/Documentation/docs.rst\n> index a6e8a59a..5871961c 100644\n> --- a/Documentation/docs.rst\n> +++ b/Documentation/docs.rst\n> @@ -3,6 +3,8 @@\n>  .. contents::\n>     :local:\n>  \n> +.. include:: documentation-contents.rst\n> +\n>  *************\n>  Documentation\n>  *************\n> diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst\n> new file mode 100644\n> index 00000000..a6915e05\n> --- /dev/null\n> +++ b/Documentation/documentation-contents.rst\n> @@ -0,0 +1,27 @@\n> +.. SPDX-License-Identifier: CC-BY-SA-4.0\n> +\n> +.. container:: documentation-nav\n> +\n> +   * :doc:`/api-html/index`\n> +   * :doc:`/camera-sensor-model`\n> +   * :doc:`/code-of-conduct`\n> +   * :doc:`/coding-style`\n> +   * :doc:`/environment_variables`\n> +   * :doc:`/guides/application-developer`\n> +   * :doc:`/guides/introduction`\n> +   * :doc:`/guides/ipa`\n> +   * :doc:`/guides/pipeline-handler`\n> +   * :doc:`/guides/tracing`\n> +   * :doc:`/lens_driver_requirements`\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\n> +   generated by sphinx. This is not relevant in libcamera nor addressed in the\n> +   theme's CSS, since all of the pages here are documentation. It **is** used\n> +   to properly format the documentation pages on libcamera.org and so should not\n> +   be removed.\n> +\n> +.. rst-class:: documentation\n> diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst\n> index de434c38..7da9883a 100644\n> --- a/Documentation/environment_variables.rst\n> +++ b/Documentation/environment_variables.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> +.. include:: documentation-contents.rst\n> +\n>  Environment variables\n>  =====================\n>  \n> diff --git a/Documentation/getting-started.rst b/Documentation/getting-started.rst\n> index 987f43f7..63b050eb 100644\n> --- a/Documentation/getting-started.rst\n> +++ b/Documentation/getting-started.rst\n> @@ -1,4 +1,5 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n> +\n>  .. Getting started information is defined in the project README file.\n>  .. include:: ../README.rst\n>     :start-after: .. section-begin-getting-started\n> diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst\n> index 92e2a373..1ea8c40f 100644\n> --- a/Documentation/guides/application-developer.rst\n> +++ b/Documentation/guides/application-developer.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> +.. include:: ../documentation-contents.rst\n> +\n>  Using libcamera in a C++ application\n>  ====================================\n>  \n> diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst\n> index 700ec2d3..8368bd4a 100644\n> --- a/Documentation/guides/introduction.rst\n> +++ b/Documentation/guides/introduction.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> +.. include:: ../documentation-contents.rst\n> +\n>  Developers guide to libcamera\n>  =============================\n>  \n> diff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst\n> index 25deadef..cd640563 100644\n> --- a/Documentation/guides/ipa.rst\n> +++ b/Documentation/guides/ipa.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> +.. include:: ../documentation-contents.rst\n> +\n>  IPA Writer's Guide\n>  ==================\n>  \n> diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\n> index 5aa09e90..26aea433 100644\n> --- a/Documentation/guides/pipeline-handler.rst\n> +++ b/Documentation/guides/pipeline-handler.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> +.. include:: ../documentation-contents.rst\n> +\n>  Pipeline Handler Writers Guide\n>  ==============================\n>  \n> diff --git a/Documentation/guides/tracing.rst b/Documentation/guides/tracing.rst\n> index ae960d85..537dce50 100644\n> --- a/Documentation/guides/tracing.rst\n> +++ b/Documentation/guides/tracing.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> +.. include:: ../documentation-contents.rst\n> +\n>  Tracing Guide\n>  =============\n>  \n> diff --git a/Documentation/lens_driver_requirements.rst b/Documentation/lens_driver_requirements.rst\n> index b96e502d..85fef76f 100644\n> --- a/Documentation/lens_driver_requirements.rst\n> +++ b/Documentation/lens_driver_requirements.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> +.. include:: documentation-contents.rst\n> +\n>  .. _lens-driver-requirements:\n>  \n>  Lens Driver Requirements\n> diff --git a/Documentation/meson.build b/Documentation/meson.build\n> index 1ba40fdf..79135b6f 100644\n> --- a/Documentation/meson.build\n> +++ b/Documentation/meson.build\n> @@ -129,6 +129,7 @@ if sphinx.found()\n>          'conf.py',\n>          'contributing.rst',\n>          'docs.rst',\n> +        'documentation-contents.rst',\n>          'environment_variables.rst',\n>          'guides/application-developer.rst',\n>          'guides/introduction.rst',\n> diff --git a/Documentation/python-bindings.rst b/Documentation/python-bindings.rst\n> index ed9f686b..94712238 100644\n> --- a/Documentation/python-bindings.rst\n> +++ b/Documentation/python-bindings.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> +.. include:: documentation-contents.rst\n> +\n>  .. _python-bindings:\n>  \n>  Python Bindings for libcamera\n> diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst\n> index 0e516b34..fb4269d0 100644\n> --- a/Documentation/sensor_driver_requirements.rst\n> +++ b/Documentation/sensor_driver_requirements.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> +.. include:: documentation-contents.rst\n> +\n>  .. _sensor-driver-requirements:\n>  \n>  Sensor Driver Requirements\n> diff --git a/Documentation/software-isp-benchmarking.rst b/Documentation/software-isp-benchmarking.rst\n> index b3033132..9c2a409b 100644\n> --- a/Documentation/software-isp-benchmarking.rst\n> +++ b/Documentation/software-isp-benchmarking.rst\n> @@ -1,5 +1,7 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> +.. include:: documentation-contents.rst\n> +\n>  .. _software-isp-benchmarking:\n>  \n>  Software ISP benchmarking\n> diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css\n> index d4274ea6..2b1ed095 100644\n> --- a/Documentation/theme/static/css/theme.css\n> +++ b/Documentation/theme/static/css/theme.css\n> @@ -289,3 +289,7 @@ div#signature {\n>  \tpadding: 0px;\n>  \tvisibility: hidden;\n>  }\n> +\n> +.documentation-nav {\n> +\tdisplay: none;\n> +}\n> -- \n> 2.34.1\n>","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 41398BDB13\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 20 Aug 2024 08:06:33 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 5A5F7633CE;\n\tTue, 20 Aug 2024 10:06:31 +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 7D06863369\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 20 Aug 2024 10:06:28 +0200 (CEST)","from ideasonboard.com (unknown\n\t[IPv6:2a00:6020:448c:6c00:25c4:d2cd:c605:3cc])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 7805F4CC;\n\tTue, 20 Aug 2024 10:05:26 +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=\"elmw5qKR\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1724141126;\n\tbh=sorRlF3XP+h1XM/t49XxNI3m7GhEX593aG6pkv8PwVo=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=elmw5qKRsjbiqA8qy5vJvxJZCz50Tnbyc+17n62g4nVWmx/fNqBp6j7WSkK2kxo9J\n\tvkoLOazghXk/DxDVdEvESH37y4JOXFoXkWpkehE10xQkuU4hEvYCrWW4KM9HbXyj7I\n\tg7zUIUtQsaPoj4+Oh0MTmnw0oolWTdWPc+uMVz48=","Date":"Tue, 20 Aug 2024 10:06:24 +0200","From":"Stefan Klug <stefan.klug@ideasonboard.com>","To":"Daniel Scally <dan.scally@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org, \n\tLaurent Pinchart <laurent.pinchart@ideasonboard.com>","Subject":"Re: [PATCH v3 1/7] Documentation: Add documentation-contents.rst","Message-ID":"<nxbnj6qmcqmojyhms3gnrzifgozhrebt4xwnci4hahpfaxvxvj@4boy6buwzbu3>","References":"<20240819160921.468981-1-dan.scally@ideasonboard.com>\n\t<20240819160921.468981-2-dan.scally@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20240819160921.468981-2-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":30869,"web_url":"https://patchwork.libcamera.org/comment/30869/","msgid":"<76a940a7-8c8e-4108-b08c-cf84a5d1ef19@ideasonboard.com>","date":"2024-08-20T10:41:35","subject":"Re: [PATCH v3 1/7] Documentation: Add documentation-contents.rst","submitter":{"id":156,"url":"https://patchwork.libcamera.org/api/people/156/","name":"Dan Scally","email":"dan.scally@ideasonboard.com"},"content":"Hi Stefan\n\nOn 20/08/2024 09:06, Stefan Klug wrote:\n> Hi Dan,\n>\n> Thank you for the patch.\n>\n> On Mon, Aug 19, 2024 at 05:09:15PM +0100, Daniel Scally wrote:\n>> Add a new .rst file referencing the documentation contents. This file\n>> is then included in each documentation page so that we can enhance\n>> the Documentation pages on the libcamera website using it. As we do\n>> not want the appearance of the libcamera in-tree Documentation to\n>> change just yet, disable the new class using the sphinx theme's CSS.\n>>\n>> To facilitate easier distinguishing between \"normal\" and\n>> documentation pages on the website we want to add a \"documentation\"\n>> class to the content of all such pages. Since this new file will be\n>> included on each documentation page it is convenient to add the new\n>> directive here - do so. As the website uses different CSS to\n>> libcamera, move the contents on docs.rst a little so that the\n>> directive at the end of the contents block applies correctly.\n> I struggle a bit with adding the documentation-contents.rst to every\n> page even though it is theoretically a property if the \"website-theme\".\n> I didn't try it out, but would it be possible to set that in the config\n> using rs_prolog? (See\n> https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_prolog)\n>\n> config.py:\n> rst_prolog = \"\"\"\n> .. include:: documentation-contents.rst\n> \"\"\"\n>\n> This way we could keep the website specifics out of the content pages\n> (as far as possible) and maybe switch between website and libcamera\n> build using sphinx-build -c ...\n\n\nI think it might make it a bit more awkward unfortunately; it would have to be in the website's \nconf.py and would then unfortunately be present on _all_ of the website's pages, rather than just \nthe documentation pages, and we'd have to figure out a way to remove them from the non-documentation \npages somehow.\n\n>\n>\n> Best regards,\n> Stefan\n>\n>> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n>> Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>\n>> ---\n>> Changes since v2:\n>>\n>> \t- Spaces instead of tabs in meson.build\n>>\n>> changes since v1:\n>>\n>> \t- Formatting\n>> \t- Properly added the new file to meson's list of docs_sources\n>> \t- Commented the inclusion of the rst-class directive at the end of the\n>> \t  new file\n>>\n>>   Documentation/camera-sensor-model.rst         |  2 ++\n>>   Documentation/code-of-conduct.rst             |  2 ++\n>>   Documentation/coding-style.rst                |  2 ++\n>>   Documentation/conf.py                         |  7 ++++-\n>>   Documentation/docs.rst                        |  2 ++\n>>   Documentation/documentation-contents.rst      | 27 +++++++++++++++++++\n>>   Documentation/environment_variables.rst       |  2 ++\n>>   Documentation/getting-started.rst             |  1 +\n>>   .../guides/application-developer.rst          |  2 ++\n>>   Documentation/guides/introduction.rst         |  2 ++\n>>   Documentation/guides/ipa.rst                  |  2 ++\n>>   Documentation/guides/pipeline-handler.rst     |  2 ++\n>>   Documentation/guides/tracing.rst              |  2 ++\n>>   Documentation/lens_driver_requirements.rst    |  2 ++\n>>   Documentation/meson.build                     |  1 +\n>>   Documentation/python-bindings.rst             |  2 ++\n>>   Documentation/sensor_driver_requirements.rst  |  2 ++\n>>   Documentation/software-isp-benchmarking.rst   |  2 ++\n>>   Documentation/theme/static/css/theme.css      |  4 +++\n>>   19 files changed, 67 insertions(+), 1 deletion(-)\n>>   create mode 100644 Documentation/documentation-contents.rst\n>>\n>> diff --git a/Documentation/camera-sensor-model.rst b/Documentation/camera-sensor-model.rst\n>> index b66c880a..87a25bf4 100644\n>> --- a/Documentation/camera-sensor-model.rst\n>> +++ b/Documentation/camera-sensor-model.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>   \n>> +.. include:: documentation-contents.rst\n>> +\n>>   .. _camera-sensor-model:\n>>   \n>>   .. todo: Move to Doxygen-generated documentation\n>> diff --git a/Documentation/code-of-conduct.rst b/Documentation/code-of-conduct.rst\n>> index 38b7d7ad..0edd1e99 100644\n>> --- a/Documentation/code-of-conduct.rst\n>> +++ b/Documentation/code-of-conduct.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-4.0\n>>   \n>> +.. include:: documentation-contents.rst\n>> +\n>>   .. _code-of-conduct:\n>>   \n>>   Contributor Covenant Code of Conduct\n>> diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst\n>> index 3352b75c..6ac3a4a0 100644\n>> --- a/Documentation/coding-style.rst\n>> +++ b/Documentation/coding-style.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>   \n>> +.. include:: documentation-contents.rst\n>> +\n>>   .. _coding-style-guidelines:\n>>   \n>>   Coding Style Guidelines\n>> diff --git a/Documentation/conf.py b/Documentation/conf.py\n>> index 7eeea7f3..325f2759 100644\n>> --- a/Documentation/conf.py\n>> +++ b/Documentation/conf.py\n>> @@ -61,7 +61,12 @@ language = 'en'\n>>   # List of patterns, relative to source directory, that match files and\n>>   # directories to ignore when looking for source files.\n>>   # This pattern also affects html_static_path and html_extra_path.\n>> -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']\n>> +exclude_patterns = [\n>> +    '_build',\n>> +    'Thumbs.db',\n>> +    '.DS_Store',\n>> +    'documentation-contents.rst',\n>> +]\n>>   \n>>   # The name of the Pygments (syntax highlighting) style to use.\n>>   pygments_style = None\n>> diff --git a/Documentation/docs.rst b/Documentation/docs.rst\n>> index a6e8a59a..5871961c 100644\n>> --- a/Documentation/docs.rst\n>> +++ b/Documentation/docs.rst\n>> @@ -3,6 +3,8 @@\n>>   .. contents::\n>>      :local:\n>>   \n>> +.. include:: documentation-contents.rst\n>> +\n>>   *************\n>>   Documentation\n>>   *************\n>> diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst\n>> new file mode 100644\n>> index 00000000..a6915e05\n>> --- /dev/null\n>> +++ b/Documentation/documentation-contents.rst\n>> @@ -0,0 +1,27 @@\n>> +.. SPDX-License-Identifier: CC-BY-SA-4.0\n>> +\n>> +.. container:: documentation-nav\n>> +\n>> +   * :doc:`/api-html/index`\n>> +   * :doc:`/camera-sensor-model`\n>> +   * :doc:`/code-of-conduct`\n>> +   * :doc:`/coding-style`\n>> +   * :doc:`/environment_variables`\n>> +   * :doc:`/guides/application-developer`\n>> +   * :doc:`/guides/introduction`\n>> +   * :doc:`/guides/ipa`\n>> +   * :doc:`/guides/pipeline-handler`\n>> +   * :doc:`/guides/tracing`\n>> +   * :doc:`/lens_driver_requirements`\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\n>> +   generated by sphinx. This is not relevant in libcamera nor addressed in the\n>> +   theme's CSS, since all of the pages here are documentation. It **is** used\n>> +   to properly format the documentation pages on libcamera.org and so should not\n>> +   be removed.\n>> +\n>> +.. rst-class:: documentation\n>> diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst\n>> index de434c38..7da9883a 100644\n>> --- a/Documentation/environment_variables.rst\n>> +++ b/Documentation/environment_variables.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>   \n>> +.. include:: documentation-contents.rst\n>> +\n>>   Environment variables\n>>   =====================\n>>   \n>> diff --git a/Documentation/getting-started.rst b/Documentation/getting-started.rst\n>> index 987f43f7..63b050eb 100644\n>> --- a/Documentation/getting-started.rst\n>> +++ b/Documentation/getting-started.rst\n>> @@ -1,4 +1,5 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>> +\n>>   .. Getting started information is defined in the project README file.\n>>   .. include:: ../README.rst\n>>      :start-after: .. section-begin-getting-started\n>> diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst\n>> index 92e2a373..1ea8c40f 100644\n>> --- a/Documentation/guides/application-developer.rst\n>> +++ b/Documentation/guides/application-developer.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>   \n>> +.. include:: ../documentation-contents.rst\n>> +\n>>   Using libcamera in a C++ application\n>>   ====================================\n>>   \n>> diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst\n>> index 700ec2d3..8368bd4a 100644\n>> --- a/Documentation/guides/introduction.rst\n>> +++ b/Documentation/guides/introduction.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>   \n>> +.. include:: ../documentation-contents.rst\n>> +\n>>   Developers guide to libcamera\n>>   =============================\n>>   \n>> diff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst\n>> index 25deadef..cd640563 100644\n>> --- a/Documentation/guides/ipa.rst\n>> +++ b/Documentation/guides/ipa.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>   \n>> +.. include:: ../documentation-contents.rst\n>> +\n>>   IPA Writer's Guide\n>>   ==================\n>>   \n>> diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\n>> index 5aa09e90..26aea433 100644\n>> --- a/Documentation/guides/pipeline-handler.rst\n>> +++ b/Documentation/guides/pipeline-handler.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>   \n>> +.. include:: ../documentation-contents.rst\n>> +\n>>   Pipeline Handler Writers Guide\n>>   ==============================\n>>   \n>> diff --git a/Documentation/guides/tracing.rst b/Documentation/guides/tracing.rst\n>> index ae960d85..537dce50 100644\n>> --- a/Documentation/guides/tracing.rst\n>> +++ b/Documentation/guides/tracing.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>   \n>> +.. include:: ../documentation-contents.rst\n>> +\n>>   Tracing Guide\n>>   =============\n>>   \n>> diff --git a/Documentation/lens_driver_requirements.rst b/Documentation/lens_driver_requirements.rst\n>> index b96e502d..85fef76f 100644\n>> --- a/Documentation/lens_driver_requirements.rst\n>> +++ b/Documentation/lens_driver_requirements.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>   \n>> +.. include:: documentation-contents.rst\n>> +\n>>   .. _lens-driver-requirements:\n>>   \n>>   Lens Driver Requirements\n>> diff --git a/Documentation/meson.build b/Documentation/meson.build\n>> index 1ba40fdf..79135b6f 100644\n>> --- a/Documentation/meson.build\n>> +++ b/Documentation/meson.build\n>> @@ -129,6 +129,7 @@ if sphinx.found()\n>>           'conf.py',\n>>           'contributing.rst',\n>>           'docs.rst',\n>> +        'documentation-contents.rst',\n>>           'environment_variables.rst',\n>>           'guides/application-developer.rst',\n>>           'guides/introduction.rst',\n>> diff --git a/Documentation/python-bindings.rst b/Documentation/python-bindings.rst\n>> index ed9f686b..94712238 100644\n>> --- a/Documentation/python-bindings.rst\n>> +++ b/Documentation/python-bindings.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>   \n>> +.. include:: documentation-contents.rst\n>> +\n>>   .. _python-bindings:\n>>   \n>>   Python Bindings for libcamera\n>> diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst\n>> index 0e516b34..fb4269d0 100644\n>> --- a/Documentation/sensor_driver_requirements.rst\n>> +++ b/Documentation/sensor_driver_requirements.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>   \n>> +.. include:: documentation-contents.rst\n>> +\n>>   .. _sensor-driver-requirements:\n>>   \n>>   Sensor Driver Requirements\n>> diff --git a/Documentation/software-isp-benchmarking.rst b/Documentation/software-isp-benchmarking.rst\n>> index b3033132..9c2a409b 100644\n>> --- a/Documentation/software-isp-benchmarking.rst\n>> +++ b/Documentation/software-isp-benchmarking.rst\n>> @@ -1,5 +1,7 @@\n>>   .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>   \n>> +.. include:: documentation-contents.rst\n>> +\n>>   .. _software-isp-benchmarking:\n>>   \n>>   Software ISP benchmarking\n>> diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css\n>> index d4274ea6..2b1ed095 100644\n>> --- a/Documentation/theme/static/css/theme.css\n>> +++ b/Documentation/theme/static/css/theme.css\n>> @@ -289,3 +289,7 @@ div#signature {\n>>   \tpadding: 0px;\n>>   \tvisibility: hidden;\n>>   }\n>> +\n>> +.documentation-nav {\n>> +\tdisplay: none;\n>> +}\n>> -- \n>> 2.34.1\n>>","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 E4122C323E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 20 Aug 2024 10:41:41 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id A6237633CE;\n\tTue, 20 Aug 2024 12:41:40 +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 31EED633B2\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 20 Aug 2024 12:41:39 +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 EB84D4CC;\n\tTue, 20 Aug 2024 12:40:36 +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=\"I+AhlGgf\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1724150437;\n\tbh=06irTFfvO9kIqltDoq4JQtPO2/4joaTrs7Cee4na90o=;\n\th=Date:Subject:To:Cc:References:From:In-Reply-To:From;\n\tb=I+AhlGgf66OVwE1ZR6t50BPiDK32qskjHtA4tqxzIhCj46gCiOU2Q07yk+yPoiW+j\n\tuk7gonlRqKWve+zZZ0xfIXDjdx4jhTS1dsKbIvowm6thCG6R5+NTxvkgaSJZutKYzh\n\t3OhrJvMeE0T7IWKaOczV1x5oJDfCjvV1XL8Z77DU=","Message-ID":"<76a940a7-8c8e-4108-b08c-cf84a5d1ef19@ideasonboard.com>","Date":"Tue, 20 Aug 2024 11:41:35 +0100","MIME-Version":"1.0","User-Agent":"Mozilla Thunderbird","Subject":"Re: [PATCH v3 1/7] Documentation: Add documentation-contents.rst","To":"Stefan Klug <stefan.klug@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org,\n\tLaurent Pinchart <laurent.pinchart@ideasonboard.com>","References":"<20240819160921.468981-1-dan.scally@ideasonboard.com>\n\t<20240819160921.468981-2-dan.scally@ideasonboard.com>\n\t<nxbnj6qmcqmojyhms3gnrzifgozhrebt4xwnci4hahpfaxvxvj@4boy6buwzbu3>","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":"<nxbnj6qmcqmojyhms3gnrzifgozhrebt4xwnci4hahpfaxvxvj@4boy6buwzbu3>","Content-Type":"text/plain; charset=UTF-8; format=flowed","Content-Transfer-Encoding":"7bit","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":30873,"web_url":"https://patchwork.libcamera.org/comment/30873/","msgid":"<cqoynbor3jpxgai2hja4bjnjcikmjdckm2lzsjk6b7cz7t7esj@wjehkq5hjeyp>","date":"2024-08-20T14:47:50","subject":"Re: [PATCH v3 1/7] Documentation: Add documentation-contents.rst","submitter":{"id":184,"url":"https://patchwork.libcamera.org/api/people/184/","name":"Stefan Klug","email":"stefan.klug@ideasonboard.com"},"content":"Hi Dan,\n\nOn Tue, Aug 20, 2024 at 11:41:35AM +0100, Dan Scally wrote:\n> Hi Stefan\n> \n> On 20/08/2024 09:06, Stefan Klug wrote:\n> > Hi Dan,\n> > \n> > Thank you for the patch.\n> > \n> > On Mon, Aug 19, 2024 at 05:09:15PM +0100, Daniel Scally wrote:\n> > > Add a new .rst file referencing the documentation contents. This file\n> > > is then included in each documentation page so that we can enhance\n> > > the Documentation pages on the libcamera website using it. As we do\n> > > not want the appearance of the libcamera in-tree Documentation to\n> > > change just yet, disable the new class using the sphinx theme's CSS.\n> > > \n> > > To facilitate easier distinguishing between \"normal\" and\n> > > documentation pages on the website we want to add a \"documentation\"\n> > > class to the content of all such pages. Since this new file will be\n> > > included on each documentation page it is convenient to add the new\n> > > directive here - do so. As the website uses different CSS to\n> > > libcamera, move the contents on docs.rst a little so that the\n> > > directive at the end of the contents block applies correctly.\n> > I struggle a bit with adding the documentation-contents.rst to every\n> > page even though it is theoretically a property if the \"website-theme\".\n> > I didn't try it out, but would it be possible to set that in the config\n> > using rs_prolog? (See\n> > https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_prolog)\n> > \n> > config.py:\n> > rst_prolog = \"\"\"\n> > .. include:: documentation-contents.rst\n> > \"\"\"\n> > \n> > This way we could keep the website specifics out of the content pages\n> > (as far as possible) and maybe switch between website and libcamera\n> > build using sphinx-build -c ...\n> \n> \n> I think it might make it a bit more awkward unfortunately; it would have to\n> be in the website's conf.py and would then unfortunately be present on _all_\n> of the website's pages, rather than just the documentation pages, and we'd\n> have to figure out a way to remove them from the non-documentation pages\n> somehow.\n\nOh, seems like I'm missing something here. Do I get it right, that the\nwhole website is generated by sphinx? In that case I can understand the\napproach and can't come up with a more elegant solution.\n\nReviewed-by: Stefan Klug <stefan.klug@ideasonboard.com> \n\nBest regards,\nStefan\n\n> \n> > \n> > \n> > Best regards,\n> > Stefan\n> > \n> > > Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> > > Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>\n> > > ---\n> > > Changes since v2:\n> > > \n> > > \t- Spaces instead of tabs in meson.build\n> > > \n> > > changes since v1:\n> > > \n> > > \t- Formatting\n> > > \t- Properly added the new file to meson's list of docs_sources\n> > > \t- Commented the inclusion of the rst-class directive at the end of the\n> > > \t  new file\n> > > \n> > >   Documentation/camera-sensor-model.rst         |  2 ++\n> > >   Documentation/code-of-conduct.rst             |  2 ++\n> > >   Documentation/coding-style.rst                |  2 ++\n> > >   Documentation/conf.py                         |  7 ++++-\n> > >   Documentation/docs.rst                        |  2 ++\n> > >   Documentation/documentation-contents.rst      | 27 +++++++++++++++++++\n> > >   Documentation/environment_variables.rst       |  2 ++\n> > >   Documentation/getting-started.rst             |  1 +\n> > >   .../guides/application-developer.rst          |  2 ++\n> > >   Documentation/guides/introduction.rst         |  2 ++\n> > >   Documentation/guides/ipa.rst                  |  2 ++\n> > >   Documentation/guides/pipeline-handler.rst     |  2 ++\n> > >   Documentation/guides/tracing.rst              |  2 ++\n> > >   Documentation/lens_driver_requirements.rst    |  2 ++\n> > >   Documentation/meson.build                     |  1 +\n> > >   Documentation/python-bindings.rst             |  2 ++\n> > >   Documentation/sensor_driver_requirements.rst  |  2 ++\n> > >   Documentation/software-isp-benchmarking.rst   |  2 ++\n> > >   Documentation/theme/static/css/theme.css      |  4 +++\n> > >   19 files changed, 67 insertions(+), 1 deletion(-)\n> > >   create mode 100644 Documentation/documentation-contents.rst\n> > > \n> > > diff --git a/Documentation/camera-sensor-model.rst b/Documentation/camera-sensor-model.rst\n> > > index b66c880a..87a25bf4 100644\n> > > --- a/Documentation/camera-sensor-model.rst\n> > > +++ b/Documentation/camera-sensor-model.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +.. include:: documentation-contents.rst\n> > > +\n> > >   .. _camera-sensor-model:\n> > >   .. todo: Move to Doxygen-generated documentation\n> > > diff --git a/Documentation/code-of-conduct.rst b/Documentation/code-of-conduct.rst\n> > > index 38b7d7ad..0edd1e99 100644\n> > > --- a/Documentation/code-of-conduct.rst\n> > > +++ b/Documentation/code-of-conduct.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-4.0\n> > > +.. include:: documentation-contents.rst\n> > > +\n> > >   .. _code-of-conduct:\n> > >   Contributor Covenant Code of Conduct\n> > > diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst\n> > > index 3352b75c..6ac3a4a0 100644\n> > > --- a/Documentation/coding-style.rst\n> > > +++ b/Documentation/coding-style.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +.. include:: documentation-contents.rst\n> > > +\n> > >   .. _coding-style-guidelines:\n> > >   Coding Style Guidelines\n> > > diff --git a/Documentation/conf.py b/Documentation/conf.py\n> > > index 7eeea7f3..325f2759 100644\n> > > --- a/Documentation/conf.py\n> > > +++ b/Documentation/conf.py\n> > > @@ -61,7 +61,12 @@ language = 'en'\n> > >   # List of patterns, relative to source directory, that match files and\n> > >   # directories to ignore when looking for source files.\n> > >   # This pattern also affects html_static_path and html_extra_path.\n> > > -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']\n> > > +exclude_patterns = [\n> > > +    '_build',\n> > > +    'Thumbs.db',\n> > > +    '.DS_Store',\n> > > +    'documentation-contents.rst',\n> > > +]\n> > >   # The name of the Pygments (syntax highlighting) style to use.\n> > >   pygments_style = None\n> > > diff --git a/Documentation/docs.rst b/Documentation/docs.rst\n> > > index a6e8a59a..5871961c 100644\n> > > --- a/Documentation/docs.rst\n> > > +++ b/Documentation/docs.rst\n> > > @@ -3,6 +3,8 @@\n> > >   .. contents::\n> > >      :local:\n> > > +.. include:: documentation-contents.rst\n> > > +\n> > >   *************\n> > >   Documentation\n> > >   *************\n> > > diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst\n> > > new file mode 100644\n> > > index 00000000..a6915e05\n> > > --- /dev/null\n> > > +++ b/Documentation/documentation-contents.rst\n> > > @@ -0,0 +1,27 @@\n> > > +.. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +\n> > > +.. container:: documentation-nav\n> > > +\n> > > +   * :doc:`/api-html/index`\n> > > +   * :doc:`/camera-sensor-model`\n> > > +   * :doc:`/code-of-conduct`\n> > > +   * :doc:`/coding-style`\n> > > +   * :doc:`/environment_variables`\n> > > +   * :doc:`/guides/application-developer`\n> > > +   * :doc:`/guides/introduction`\n> > > +   * :doc:`/guides/ipa`\n> > > +   * :doc:`/guides/pipeline-handler`\n> > > +   * :doc:`/guides/tracing`\n> > > +   * :doc:`/lens_driver_requirements`\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\n> > > +   generated by sphinx. This is not relevant in libcamera nor addressed in the\n> > > +   theme's CSS, since all of the pages here are documentation. It **is** used\n> > > +   to properly format the documentation pages on libcamera.org and so should not\n> > > +   be removed.\n> > > +\n> > > +.. rst-class:: documentation\n> > > diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst\n> > > index de434c38..7da9883a 100644\n> > > --- a/Documentation/environment_variables.rst\n> > > +++ b/Documentation/environment_variables.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +.. include:: documentation-contents.rst\n> > > +\n> > >   Environment variables\n> > >   =====================\n> > > diff --git a/Documentation/getting-started.rst b/Documentation/getting-started.rst\n> > > index 987f43f7..63b050eb 100644\n> > > --- a/Documentation/getting-started.rst\n> > > +++ b/Documentation/getting-started.rst\n> > > @@ -1,4 +1,5 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +\n> > >   .. Getting started information is defined in the project README file.\n> > >   .. include:: ../README.rst\n> > >      :start-after: .. section-begin-getting-started\n> > > diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst\n> > > index 92e2a373..1ea8c40f 100644\n> > > --- a/Documentation/guides/application-developer.rst\n> > > +++ b/Documentation/guides/application-developer.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +.. include:: ../documentation-contents.rst\n> > > +\n> > >   Using libcamera in a C++ application\n> > >   ====================================\n> > > diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst\n> > > index 700ec2d3..8368bd4a 100644\n> > > --- a/Documentation/guides/introduction.rst\n> > > +++ b/Documentation/guides/introduction.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +.. include:: ../documentation-contents.rst\n> > > +\n> > >   Developers guide to libcamera\n> > >   =============================\n> > > diff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst\n> > > index 25deadef..cd640563 100644\n> > > --- a/Documentation/guides/ipa.rst\n> > > +++ b/Documentation/guides/ipa.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +.. include:: ../documentation-contents.rst\n> > > +\n> > >   IPA Writer's Guide\n> > >   ==================\n> > > diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\n> > > index 5aa09e90..26aea433 100644\n> > > --- a/Documentation/guides/pipeline-handler.rst\n> > > +++ b/Documentation/guides/pipeline-handler.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +.. include:: ../documentation-contents.rst\n> > > +\n> > >   Pipeline Handler Writers Guide\n> > >   ==============================\n> > > diff --git a/Documentation/guides/tracing.rst b/Documentation/guides/tracing.rst\n> > > index ae960d85..537dce50 100644\n> > > --- a/Documentation/guides/tracing.rst\n> > > +++ b/Documentation/guides/tracing.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +.. include:: ../documentation-contents.rst\n> > > +\n> > >   Tracing Guide\n> > >   =============\n> > > diff --git a/Documentation/lens_driver_requirements.rst b/Documentation/lens_driver_requirements.rst\n> > > index b96e502d..85fef76f 100644\n> > > --- a/Documentation/lens_driver_requirements.rst\n> > > +++ b/Documentation/lens_driver_requirements.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +.. include:: documentation-contents.rst\n> > > +\n> > >   .. _lens-driver-requirements:\n> > >   Lens Driver Requirements\n> > > diff --git a/Documentation/meson.build b/Documentation/meson.build\n> > > index 1ba40fdf..79135b6f 100644\n> > > --- a/Documentation/meson.build\n> > > +++ b/Documentation/meson.build\n> > > @@ -129,6 +129,7 @@ if sphinx.found()\n> > >           'conf.py',\n> > >           'contributing.rst',\n> > >           'docs.rst',\n> > > +        'documentation-contents.rst',\n> > >           'environment_variables.rst',\n> > >           'guides/application-developer.rst',\n> > >           'guides/introduction.rst',\n> > > diff --git a/Documentation/python-bindings.rst b/Documentation/python-bindings.rst\n> > > index ed9f686b..94712238 100644\n> > > --- a/Documentation/python-bindings.rst\n> > > +++ b/Documentation/python-bindings.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +.. include:: documentation-contents.rst\n> > > +\n> > >   .. _python-bindings:\n> > >   Python Bindings for libcamera\n> > > diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst\n> > > index 0e516b34..fb4269d0 100644\n> > > --- a/Documentation/sensor_driver_requirements.rst\n> > > +++ b/Documentation/sensor_driver_requirements.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +.. include:: documentation-contents.rst\n> > > +\n> > >   .. _sensor-driver-requirements:\n> > >   Sensor Driver Requirements\n> > > diff --git a/Documentation/software-isp-benchmarking.rst b/Documentation/software-isp-benchmarking.rst\n> > > index b3033132..9c2a409b 100644\n> > > --- a/Documentation/software-isp-benchmarking.rst\n> > > +++ b/Documentation/software-isp-benchmarking.rst\n> > > @@ -1,5 +1,7 @@\n> > >   .. SPDX-License-Identifier: CC-BY-SA-4.0\n> > > +.. include:: documentation-contents.rst\n> > > +\n> > >   .. _software-isp-benchmarking:\n> > >   Software ISP benchmarking\n> > > diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css\n> > > index d4274ea6..2b1ed095 100644\n> > > --- a/Documentation/theme/static/css/theme.css\n> > > +++ b/Documentation/theme/static/css/theme.css\n> > > @@ -289,3 +289,7 @@ div#signature {\n> > >   \tpadding: 0px;\n> > >   \tvisibility: hidden;\n> > >   }\n> > > +\n> > > +.documentation-nav {\n> > > +\tdisplay: none;\n> > > +}\n> > > -- \n> > > 2.34.1\n> > >","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 BF97DC323E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 20 Aug 2024 14:47:55 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 9A507633CE;\n\tTue, 20 Aug 2024 16:47:54 +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 08E94633B2\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 20 Aug 2024 16:47:53 +0200 (CEST)","from ideasonboard.com (unknown\n\t[IPv6:2a00:6020:448c:6c00:b7b8:6f3c:9412:443d])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id CE964541;\n\tTue, 20 Aug 2024 16:46:50 +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=\"dC4jDQrW\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1724165210;\n\tbh=OITmVgeHrFgVP75PCBfkQ5HH/iHvSoq147abcQQXr7Y=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=dC4jDQrWdBeqw3v8vDTdcBm577mgGQ/pk0lOL5QhloydGP7cyXEpHtbVjj5PtYjAO\n\t388uABdoFGGuYpwV+qWOeBZAeY0mgnIRY77nvDKOfnHiiTiupZwkAAMVL/OZy0Z+hd\n\tUQsXIJMUBAJziWd30c3ZBwWgdI4NEvdPRIgTSeHw=","Date":"Tue, 20 Aug 2024 16:47:50 +0200","From":"Stefan Klug <stefan.klug@ideasonboard.com>","To":"Dan Scally <dan.scally@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org, \n\tLaurent Pinchart <laurent.pinchart@ideasonboard.com>","Subject":"Re: [PATCH v3 1/7] Documentation: Add documentation-contents.rst","Message-ID":"<cqoynbor3jpxgai2hja4bjnjcikmjdckm2lzsjk6b7cz7t7esj@wjehkq5hjeyp>","References":"<20240819160921.468981-1-dan.scally@ideasonboard.com>\n\t<20240819160921.468981-2-dan.scally@ideasonboard.com>\n\t<nxbnj6qmcqmojyhms3gnrzifgozhrebt4xwnci4hahpfaxvxvj@4boy6buwzbu3>\n\t<76a940a7-8c8e-4108-b08c-cf84a5d1ef19@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<76a940a7-8c8e-4108-b08c-cf84a5d1ef19@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":30874,"web_url":"https://patchwork.libcamera.org/comment/30874/","msgid":"<6daf3228-fc93-4cb9-a019-ae52c85f13b7@ideasonboard.com>","date":"2024-08-20T14:57:20","subject":"Re: [PATCH v3 1/7] Documentation: Add documentation-contents.rst","submitter":{"id":156,"url":"https://patchwork.libcamera.org/api/people/156/","name":"Dan Scally","email":"dan.scally@ideasonboard.com"},"content":"Hi Stefan\n\nOn 20/08/2024 15:47, Stefan Klug wrote:\n> Hi Dan,\n>\n> On Tue, Aug 20, 2024 at 11:41:35AM +0100, Dan Scally wrote:\n>> Hi Stefan\n>>\n>> On 20/08/2024 09:06, Stefan Klug wrote:\n>>> Hi Dan,\n>>>\n>>> Thank you for the patch.\n>>>\n>>> On Mon, Aug 19, 2024 at 05:09:15PM +0100, Daniel Scally wrote:\n>>>> Add a new .rst file referencing the documentation contents. This file\n>>>> is then included in each documentation page so that we can enhance\n>>>> the Documentation pages on the libcamera website using it. As we do\n>>>> not want the appearance of the libcamera in-tree Documentation to\n>>>> change just yet, disable the new class using the sphinx theme's CSS.\n>>>>\n>>>> To facilitate easier distinguishing between \"normal\" and\n>>>> documentation pages on the website we want to add a \"documentation\"\n>>>> class to the content of all such pages. Since this new file will be\n>>>> included on each documentation page it is convenient to add the new\n>>>> directive here - do so. As the website uses different CSS to\n>>>> libcamera, move the contents on docs.rst a little so that the\n>>>> directive at the end of the contents block applies correctly.\n>>> I struggle a bit with adding the documentation-contents.rst to every\n>>> page even though it is theoretically a property if the \"website-theme\".\n>>> I didn't try it out, but would it be possible to set that in the config\n>>> using rs_prolog? (See\n>>> https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_prolog)\n>>>\n>>> config.py:\n>>> rst_prolog = \"\"\"\n>>> .. include:: documentation-contents.rst\n>>> \"\"\"\n>>>\n>>> This way we could keep the website specifics out of the content pages\n>>> (as far as possible) and maybe switch between website and libcamera\n>>> build using sphinx-build -c ...\n>>\n>> I think it might make it a bit more awkward unfortunately; it would have to\n>> be in the website's conf.py and would then unfortunately be present on _all_\n>> of the website's pages, rather than just the documentation pages, and we'd\n>> have to figure out a way to remove them from the non-documentation pages\n>> somehow.\n> Oh, seems like I'm missing something here. Do I get it right, that the\n> whole website is generated by sphinx?\n\n\nYes that's right, with any pages wanted from libcamera just symlinked into the website's tree.\n\n> In that case I can understand the\n> approach and can't come up with a more elegant solution.\n>\n> Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com>\n\n\nThanks!\n\n>\n> Best regards,\n> Stefan\n>\n>>>\n>>> Best regards,\n>>> Stefan\n>>>\n>>>> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n>>>> Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>\n>>>> ---\n>>>> Changes since v2:\n>>>>\n>>>> \t- Spaces instead of tabs in meson.build\n>>>>\n>>>> changes since v1:\n>>>>\n>>>> \t- Formatting\n>>>> \t- Properly added the new file to meson's list of docs_sources\n>>>> \t- Commented the inclusion of the rst-class directive at the end of the\n>>>> \t  new file\n>>>>\n>>>>    Documentation/camera-sensor-model.rst         |  2 ++\n>>>>    Documentation/code-of-conduct.rst             |  2 ++\n>>>>    Documentation/coding-style.rst                |  2 ++\n>>>>    Documentation/conf.py                         |  7 ++++-\n>>>>    Documentation/docs.rst                        |  2 ++\n>>>>    Documentation/documentation-contents.rst      | 27 +++++++++++++++++++\n>>>>    Documentation/environment_variables.rst       |  2 ++\n>>>>    Documentation/getting-started.rst             |  1 +\n>>>>    .../guides/application-developer.rst          |  2 ++\n>>>>    Documentation/guides/introduction.rst         |  2 ++\n>>>>    Documentation/guides/ipa.rst                  |  2 ++\n>>>>    Documentation/guides/pipeline-handler.rst     |  2 ++\n>>>>    Documentation/guides/tracing.rst              |  2 ++\n>>>>    Documentation/lens_driver_requirements.rst    |  2 ++\n>>>>    Documentation/meson.build                     |  1 +\n>>>>    Documentation/python-bindings.rst             |  2 ++\n>>>>    Documentation/sensor_driver_requirements.rst  |  2 ++\n>>>>    Documentation/software-isp-benchmarking.rst   |  2 ++\n>>>>    Documentation/theme/static/css/theme.css      |  4 +++\n>>>>    19 files changed, 67 insertions(+), 1 deletion(-)\n>>>>    create mode 100644 Documentation/documentation-contents.rst\n>>>>\n>>>> diff --git a/Documentation/camera-sensor-model.rst b/Documentation/camera-sensor-model.rst\n>>>> index b66c880a..87a25bf4 100644\n>>>> --- a/Documentation/camera-sensor-model.rst\n>>>> +++ b/Documentation/camera-sensor-model.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +.. include:: documentation-contents.rst\n>>>> +\n>>>>    .. _camera-sensor-model:\n>>>>    .. todo: Move to Doxygen-generated documentation\n>>>> diff --git a/Documentation/code-of-conduct.rst b/Documentation/code-of-conduct.rst\n>>>> index 38b7d7ad..0edd1e99 100644\n>>>> --- a/Documentation/code-of-conduct.rst\n>>>> +++ b/Documentation/code-of-conduct.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-4.0\n>>>> +.. include:: documentation-contents.rst\n>>>> +\n>>>>    .. _code-of-conduct:\n>>>>    Contributor Covenant Code of Conduct\n>>>> diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst\n>>>> index 3352b75c..6ac3a4a0 100644\n>>>> --- a/Documentation/coding-style.rst\n>>>> +++ b/Documentation/coding-style.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +.. include:: documentation-contents.rst\n>>>> +\n>>>>    .. _coding-style-guidelines:\n>>>>    Coding Style Guidelines\n>>>> diff --git a/Documentation/conf.py b/Documentation/conf.py\n>>>> index 7eeea7f3..325f2759 100644\n>>>> --- a/Documentation/conf.py\n>>>> +++ b/Documentation/conf.py\n>>>> @@ -61,7 +61,12 @@ language = 'en'\n>>>>    # List of patterns, relative to source directory, that match files and\n>>>>    # directories to ignore when looking for source files.\n>>>>    # This pattern also affects html_static_path and html_extra_path.\n>>>> -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']\n>>>> +exclude_patterns = [\n>>>> +    '_build',\n>>>> +    'Thumbs.db',\n>>>> +    '.DS_Store',\n>>>> +    'documentation-contents.rst',\n>>>> +]\n>>>>    # The name of the Pygments (syntax highlighting) style to use.\n>>>>    pygments_style = None\n>>>> diff --git a/Documentation/docs.rst b/Documentation/docs.rst\n>>>> index a6e8a59a..5871961c 100644\n>>>> --- a/Documentation/docs.rst\n>>>> +++ b/Documentation/docs.rst\n>>>> @@ -3,6 +3,8 @@\n>>>>    .. contents::\n>>>>       :local:\n>>>> +.. include:: documentation-contents.rst\n>>>> +\n>>>>    *************\n>>>>    Documentation\n>>>>    *************\n>>>> diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst\n>>>> new file mode 100644\n>>>> index 00000000..a6915e05\n>>>> --- /dev/null\n>>>> +++ b/Documentation/documentation-contents.rst\n>>>> @@ -0,0 +1,27 @@\n>>>> +.. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +\n>>>> +.. container:: documentation-nav\n>>>> +\n>>>> +   * :doc:`/api-html/index`\n>>>> +   * :doc:`/camera-sensor-model`\n>>>> +   * :doc:`/code-of-conduct`\n>>>> +   * :doc:`/coding-style`\n>>>> +   * :doc:`/environment_variables`\n>>>> +   * :doc:`/guides/application-developer`\n>>>> +   * :doc:`/guides/introduction`\n>>>> +   * :doc:`/guides/ipa`\n>>>> +   * :doc:`/guides/pipeline-handler`\n>>>> +   * :doc:`/guides/tracing`\n>>>> +   * :doc:`/lens_driver_requirements`\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\n>>>> +   generated by sphinx. This is not relevant in libcamera nor addressed in the\n>>>> +   theme's CSS, since all of the pages here are documentation. It **is** used\n>>>> +   to properly format the documentation pages on libcamera.org and so should not\n>>>> +   be removed.\n>>>> +\n>>>> +.. rst-class:: documentation\n>>>> diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst\n>>>> index de434c38..7da9883a 100644\n>>>> --- a/Documentation/environment_variables.rst\n>>>> +++ b/Documentation/environment_variables.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +.. include:: documentation-contents.rst\n>>>> +\n>>>>    Environment variables\n>>>>    =====================\n>>>> diff --git a/Documentation/getting-started.rst b/Documentation/getting-started.rst\n>>>> index 987f43f7..63b050eb 100644\n>>>> --- a/Documentation/getting-started.rst\n>>>> +++ b/Documentation/getting-started.rst\n>>>> @@ -1,4 +1,5 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +\n>>>>    .. Getting started information is defined in the project README file.\n>>>>    .. include:: ../README.rst\n>>>>       :start-after: .. section-begin-getting-started\n>>>> diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst\n>>>> index 92e2a373..1ea8c40f 100644\n>>>> --- a/Documentation/guides/application-developer.rst\n>>>> +++ b/Documentation/guides/application-developer.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +.. include:: ../documentation-contents.rst\n>>>> +\n>>>>    Using libcamera in a C++ application\n>>>>    ====================================\n>>>> diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst\n>>>> index 700ec2d3..8368bd4a 100644\n>>>> --- a/Documentation/guides/introduction.rst\n>>>> +++ b/Documentation/guides/introduction.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +.. include:: ../documentation-contents.rst\n>>>> +\n>>>>    Developers guide to libcamera\n>>>>    =============================\n>>>> diff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst\n>>>> index 25deadef..cd640563 100644\n>>>> --- a/Documentation/guides/ipa.rst\n>>>> +++ b/Documentation/guides/ipa.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +.. include:: ../documentation-contents.rst\n>>>> +\n>>>>    IPA Writer's Guide\n>>>>    ==================\n>>>> diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\n>>>> index 5aa09e90..26aea433 100644\n>>>> --- a/Documentation/guides/pipeline-handler.rst\n>>>> +++ b/Documentation/guides/pipeline-handler.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +.. include:: ../documentation-contents.rst\n>>>> +\n>>>>    Pipeline Handler Writers Guide\n>>>>    ==============================\n>>>> diff --git a/Documentation/guides/tracing.rst b/Documentation/guides/tracing.rst\n>>>> index ae960d85..537dce50 100644\n>>>> --- a/Documentation/guides/tracing.rst\n>>>> +++ b/Documentation/guides/tracing.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +.. include:: ../documentation-contents.rst\n>>>> +\n>>>>    Tracing Guide\n>>>>    =============\n>>>> diff --git a/Documentation/lens_driver_requirements.rst b/Documentation/lens_driver_requirements.rst\n>>>> index b96e502d..85fef76f 100644\n>>>> --- a/Documentation/lens_driver_requirements.rst\n>>>> +++ b/Documentation/lens_driver_requirements.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +.. include:: documentation-contents.rst\n>>>> +\n>>>>    .. _lens-driver-requirements:\n>>>>    Lens Driver Requirements\n>>>> diff --git a/Documentation/meson.build b/Documentation/meson.build\n>>>> index 1ba40fdf..79135b6f 100644\n>>>> --- a/Documentation/meson.build\n>>>> +++ b/Documentation/meson.build\n>>>> @@ -129,6 +129,7 @@ if sphinx.found()\n>>>>            'conf.py',\n>>>>            'contributing.rst',\n>>>>            'docs.rst',\n>>>> +        'documentation-contents.rst',\n>>>>            'environment_variables.rst',\n>>>>            'guides/application-developer.rst',\n>>>>            'guides/introduction.rst',\n>>>> diff --git a/Documentation/python-bindings.rst b/Documentation/python-bindings.rst\n>>>> index ed9f686b..94712238 100644\n>>>> --- a/Documentation/python-bindings.rst\n>>>> +++ b/Documentation/python-bindings.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +.. include:: documentation-contents.rst\n>>>> +\n>>>>    .. _python-bindings:\n>>>>    Python Bindings for libcamera\n>>>> diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst\n>>>> index 0e516b34..fb4269d0 100644\n>>>> --- a/Documentation/sensor_driver_requirements.rst\n>>>> +++ b/Documentation/sensor_driver_requirements.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +.. include:: documentation-contents.rst\n>>>> +\n>>>>    .. _sensor-driver-requirements:\n>>>>    Sensor Driver Requirements\n>>>> diff --git a/Documentation/software-isp-benchmarking.rst b/Documentation/software-isp-benchmarking.rst\n>>>> index b3033132..9c2a409b 100644\n>>>> --- a/Documentation/software-isp-benchmarking.rst\n>>>> +++ b/Documentation/software-isp-benchmarking.rst\n>>>> @@ -1,5 +1,7 @@\n>>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n>>>> +.. include:: documentation-contents.rst\n>>>> +\n>>>>    .. _software-isp-benchmarking:\n>>>>    Software ISP benchmarking\n>>>> diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css\n>>>> index d4274ea6..2b1ed095 100644\n>>>> --- a/Documentation/theme/static/css/theme.css\n>>>> +++ b/Documentation/theme/static/css/theme.css\n>>>> @@ -289,3 +289,7 @@ div#signature {\n>>>>    \tpadding: 0px;\n>>>>    \tvisibility: hidden;\n>>>>    }\n>>>> +\n>>>> +.documentation-nav {\n>>>> +\tdisplay: none;\n>>>> +}\n>>>> -- \n>>>> 2.34.1\n>>>>","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 37065BDB13\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 20 Aug 2024 14:57:26 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 3F86C633CE;\n\tTue, 20 Aug 2024 16:57:25 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 2F3EA633B2\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 20 Aug 2024 16:57:24 +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 D4D2C541;\n\tTue, 20 Aug 2024 16:56:21 +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=\"HBz2dGll\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1724165782;\n\tbh=xlunQXCKcRzA4QaMLwyKJMM9b0yTNp98jEwDb7gc2uc=;\n\th=Date:Subject:To:Cc:References:From:In-Reply-To:From;\n\tb=HBz2dGllYFq7BEVp60F32zi2/M85BC/V1Ti+9dPiqDwCL8WfvV/lDl5UQc0c/gknw\n\tr8btYgsUbEQ3FQrFWZYiyswlAVDCqgxeWDRjfuo+OMtZN8JK2e8zkkgXQUXnIt6YM/\n\t+C/DpqIQTCg9s1GG7f1wiaZ7w9mRh3q5TVZJCFMU=","Message-ID":"<6daf3228-fc93-4cb9-a019-ae52c85f13b7@ideasonboard.com>","Date":"Tue, 20 Aug 2024 15:57:20 +0100","MIME-Version":"1.0","User-Agent":"Mozilla Thunderbird","Subject":"Re: [PATCH v3 1/7] Documentation: Add documentation-contents.rst","To":"Stefan Klug <stefan.klug@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org,\n\tLaurent Pinchart <laurent.pinchart@ideasonboard.com>","References":"<20240819160921.468981-1-dan.scally@ideasonboard.com>\n\t<20240819160921.468981-2-dan.scally@ideasonboard.com>\n\t<nxbnj6qmcqmojyhms3gnrzifgozhrebt4xwnci4hahpfaxvxvj@4boy6buwzbu3>\n\t<76a940a7-8c8e-4108-b08c-cf84a5d1ef19@ideasonboard.com>\n\t<cqoynbor3jpxgai2hja4bjnjcikmjdckm2lzsjk6b7cz7t7esj@wjehkq5hjeyp>","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":"<cqoynbor3jpxgai2hja4bjnjcikmjdckm2lzsjk6b7cz7t7esj@wjehkq5hjeyp>","Content-Type":"text/plain; charset=UTF-8; format=flowed","Content-Transfer-Encoding":"7bit","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":30875,"web_url":"https://patchwork.libcamera.org/comment/30875/","msgid":"<20240820150332.GA12401@pendragon.ideasonboard.com>","date":"2024-08-20T15:03:32","subject":"Re: [PATCH v3 1/7] Documentation: Add documentation-contents.rst","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"On Tue, Aug 20, 2024 at 03:57:20PM +0100, Daniel Scally wrote:\n> On 20/08/2024 15:47, Stefan Klug wrote:\n> > On Tue, Aug 20, 2024 at 11:41:35AM +0100, Dan Scally wrote:\n> >> On 20/08/2024 09:06, Stefan Klug wrote:\n> >>> On Mon, Aug 19, 2024 at 05:09:15PM +0100, Daniel Scally wrote:\n> >>>> Add a new .rst file referencing the documentation contents. This file\n> >>>> is then included in each documentation page so that we can enhance\n> >>>> the Documentation pages on the libcamera website using it. As we do\n> >>>> not want the appearance of the libcamera in-tree Documentation to\n> >>>> change just yet, disable the new class using the sphinx theme's CSS.\n> >>>>\n> >>>> To facilitate easier distinguishing between \"normal\" and\n> >>>> documentation pages on the website we want to add a \"documentation\"\n> >>>> class to the content of all such pages. Since this new file will be\n> >>>> included on each documentation page it is convenient to add the new\n> >>>> directive here - do so. As the website uses different CSS to\n> >>>> libcamera, move the contents on docs.rst a little so that the\n> >>>> directive at the end of the contents block applies correctly.\n> >>> I struggle a bit with adding the documentation-contents.rst to every\n> >>> page even though it is theoretically a property if the \"website-theme\".\n> >>> I didn't try it out, but would it be possible to set that in the config\n> >>> using rs_prolog? (See\n> >>> https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-rst_prolog)\n> >>>\n> >>> config.py:\n> >>> rst_prolog = \"\"\"\n> >>> .. include:: documentation-contents.rst\n> >>> \"\"\"\n> >>>\n> >>> This way we could keep the website specifics out of the content pages\n> >>> (as far as possible) and maybe switch between website and libcamera\n> >>> build using sphinx-build -c ...\n> >>\n> >> I think it might make it a bit more awkward unfortunately; it would have to\n> >> be in the website's conf.py and would then unfortunately be present on _all_\n> >> of the website's pages, rather than just the documentation pages, and we'd\n> >> have to figure out a way to remove them from the non-documentation pages\n> >> somehow.\n> >\n> > Oh, seems like I'm missing something here. Do I get it right, that the\n> > whole website is generated by sphinx?\n> \n> Yes that's right, with any pages wanted from libcamera just symlinked\n> into the website's tree.\n\nFinding people with experience *and* interest in website design who\ncould clean up all this has proven difficult so far. I still have hope\n:-)\n\n> > In that case I can understand the\n> > approach and can't come up with a more elegant solution.\n> >\n> > Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com>\n> \n> Thanks!\n> \n> >>>> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> >>>> Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>\n> >>>> ---\n> >>>> Changes since v2:\n> >>>>\n> >>>> \t- Spaces instead of tabs in meson.build\n> >>>>\n> >>>> changes since v1:\n> >>>>\n> >>>> \t- Formatting\n> >>>> \t- Properly added the new file to meson's list of docs_sources\n> >>>> \t- Commented the inclusion of the rst-class directive at the end of the\n> >>>> \t  new file\n> >>>>\n> >>>>    Documentation/camera-sensor-model.rst         |  2 ++\n> >>>>    Documentation/code-of-conduct.rst             |  2 ++\n> >>>>    Documentation/coding-style.rst                |  2 ++\n> >>>>    Documentation/conf.py                         |  7 ++++-\n> >>>>    Documentation/docs.rst                        |  2 ++\n> >>>>    Documentation/documentation-contents.rst      | 27 +++++++++++++++++++\n> >>>>    Documentation/environment_variables.rst       |  2 ++\n> >>>>    Documentation/getting-started.rst             |  1 +\n> >>>>    .../guides/application-developer.rst          |  2 ++\n> >>>>    Documentation/guides/introduction.rst         |  2 ++\n> >>>>    Documentation/guides/ipa.rst                  |  2 ++\n> >>>>    Documentation/guides/pipeline-handler.rst     |  2 ++\n> >>>>    Documentation/guides/tracing.rst              |  2 ++\n> >>>>    Documentation/lens_driver_requirements.rst    |  2 ++\n> >>>>    Documentation/meson.build                     |  1 +\n> >>>>    Documentation/python-bindings.rst             |  2 ++\n> >>>>    Documentation/sensor_driver_requirements.rst  |  2 ++\n> >>>>    Documentation/software-isp-benchmarking.rst   |  2 ++\n> >>>>    Documentation/theme/static/css/theme.css      |  4 +++\n> >>>>    19 files changed, 67 insertions(+), 1 deletion(-)\n> >>>>    create mode 100644 Documentation/documentation-contents.rst\n> >>>>\n> >>>> diff --git a/Documentation/camera-sensor-model.rst b/Documentation/camera-sensor-model.rst\n> >>>> index b66c880a..87a25bf4 100644\n> >>>> --- a/Documentation/camera-sensor-model.rst\n> >>>> +++ b/Documentation/camera-sensor-model.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +.. include:: documentation-contents.rst\n> >>>> +\n> >>>>    .. _camera-sensor-model:\n> >>>>    .. todo: Move to Doxygen-generated documentation\n> >>>> diff --git a/Documentation/code-of-conduct.rst b/Documentation/code-of-conduct.rst\n> >>>> index 38b7d7ad..0edd1e99 100644\n> >>>> --- a/Documentation/code-of-conduct.rst\n> >>>> +++ b/Documentation/code-of-conduct.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-4.0\n> >>>> +.. include:: documentation-contents.rst\n> >>>> +\n> >>>>    .. _code-of-conduct:\n> >>>>    Contributor Covenant Code of Conduct\n> >>>> diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst\n> >>>> index 3352b75c..6ac3a4a0 100644\n> >>>> --- a/Documentation/coding-style.rst\n> >>>> +++ b/Documentation/coding-style.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +.. include:: documentation-contents.rst\n> >>>> +\n> >>>>    .. _coding-style-guidelines:\n> >>>>    Coding Style Guidelines\n> >>>> diff --git a/Documentation/conf.py b/Documentation/conf.py\n> >>>> index 7eeea7f3..325f2759 100644\n> >>>> --- a/Documentation/conf.py\n> >>>> +++ b/Documentation/conf.py\n> >>>> @@ -61,7 +61,12 @@ language = 'en'\n> >>>>    # List of patterns, relative to source directory, that match files and\n> >>>>    # directories to ignore when looking for source files.\n> >>>>    # This pattern also affects html_static_path and html_extra_path.\n> >>>> -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']\n> >>>> +exclude_patterns = [\n> >>>> +    '_build',\n> >>>> +    'Thumbs.db',\n> >>>> +    '.DS_Store',\n> >>>> +    'documentation-contents.rst',\n> >>>> +]\n> >>>>    # The name of the Pygments (syntax highlighting) style to use.\n> >>>>    pygments_style = None\n> >>>> diff --git a/Documentation/docs.rst b/Documentation/docs.rst\n> >>>> index a6e8a59a..5871961c 100644\n> >>>> --- a/Documentation/docs.rst\n> >>>> +++ b/Documentation/docs.rst\n> >>>> @@ -3,6 +3,8 @@\n> >>>>    .. contents::\n> >>>>       :local:\n> >>>> +.. include:: documentation-contents.rst\n> >>>> +\n> >>>>    *************\n> >>>>    Documentation\n> >>>>    *************\n> >>>> diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst\n> >>>> new file mode 100644\n> >>>> index 00000000..a6915e05\n> >>>> --- /dev/null\n> >>>> +++ b/Documentation/documentation-contents.rst\n> >>>> @@ -0,0 +1,27 @@\n> >>>> +.. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +\n> >>>> +.. container:: documentation-nav\n> >>>> +\n> >>>> +   * :doc:`/api-html/index`\n> >>>> +   * :doc:`/camera-sensor-model`\n> >>>> +   * :doc:`/code-of-conduct`\n> >>>> +   * :doc:`/coding-style`\n> >>>> +   * :doc:`/environment_variables`\n> >>>> +   * :doc:`/guides/application-developer`\n> >>>> +   * :doc:`/guides/introduction`\n> >>>> +   * :doc:`/guides/ipa`\n> >>>> +   * :doc:`/guides/pipeline-handler`\n> >>>> +   * :doc:`/guides/tracing`\n> >>>> +   * :doc:`/lens_driver_requirements`\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\n> >>>> +   generated by sphinx. This is not relevant in libcamera nor addressed in the\n> >>>> +   theme's CSS, since all of the pages here are documentation. It **is** used\n> >>>> +   to properly format the documentation pages on libcamera.org and so should not\n> >>>> +   be removed.\n> >>>> +\n> >>>> +.. rst-class:: documentation\n> >>>> diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst\n> >>>> index de434c38..7da9883a 100644\n> >>>> --- a/Documentation/environment_variables.rst\n> >>>> +++ b/Documentation/environment_variables.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +.. include:: documentation-contents.rst\n> >>>> +\n> >>>>    Environment variables\n> >>>>    =====================\n> >>>> diff --git a/Documentation/getting-started.rst b/Documentation/getting-started.rst\n> >>>> index 987f43f7..63b050eb 100644\n> >>>> --- a/Documentation/getting-started.rst\n> >>>> +++ b/Documentation/getting-started.rst\n> >>>> @@ -1,4 +1,5 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +\n> >>>>    .. Getting started information is defined in the project README file.\n> >>>>    .. include:: ../README.rst\n> >>>>       :start-after: .. section-begin-getting-started\n> >>>> diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst\n> >>>> index 92e2a373..1ea8c40f 100644\n> >>>> --- a/Documentation/guides/application-developer.rst\n> >>>> +++ b/Documentation/guides/application-developer.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +.. include:: ../documentation-contents.rst\n> >>>> +\n> >>>>    Using libcamera in a C++ application\n> >>>>    ====================================\n> >>>> diff --git a/Documentation/guides/introduction.rst b/Documentation/guides/introduction.rst\n> >>>> index 700ec2d3..8368bd4a 100644\n> >>>> --- a/Documentation/guides/introduction.rst\n> >>>> +++ b/Documentation/guides/introduction.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +.. include:: ../documentation-contents.rst\n> >>>> +\n> >>>>    Developers guide to libcamera\n> >>>>    =============================\n> >>>> diff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst\n> >>>> index 25deadef..cd640563 100644\n> >>>> --- a/Documentation/guides/ipa.rst\n> >>>> +++ b/Documentation/guides/ipa.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +.. include:: ../documentation-contents.rst\n> >>>> +\n> >>>>    IPA Writer's Guide\n> >>>>    ==================\n> >>>> diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst\n> >>>> index 5aa09e90..26aea433 100644\n> >>>> --- a/Documentation/guides/pipeline-handler.rst\n> >>>> +++ b/Documentation/guides/pipeline-handler.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +.. include:: ../documentation-contents.rst\n> >>>> +\n> >>>>    Pipeline Handler Writers Guide\n> >>>>    ==============================\n> >>>> diff --git a/Documentation/guides/tracing.rst b/Documentation/guides/tracing.rst\n> >>>> index ae960d85..537dce50 100644\n> >>>> --- a/Documentation/guides/tracing.rst\n> >>>> +++ b/Documentation/guides/tracing.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +.. include:: ../documentation-contents.rst\n> >>>> +\n> >>>>    Tracing Guide\n> >>>>    =============\n> >>>> diff --git a/Documentation/lens_driver_requirements.rst b/Documentation/lens_driver_requirements.rst\n> >>>> index b96e502d..85fef76f 100644\n> >>>> --- a/Documentation/lens_driver_requirements.rst\n> >>>> +++ b/Documentation/lens_driver_requirements.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +.. include:: documentation-contents.rst\n> >>>> +\n> >>>>    .. _lens-driver-requirements:\n> >>>>    Lens Driver Requirements\n> >>>> diff --git a/Documentation/meson.build b/Documentation/meson.build\n> >>>> index 1ba40fdf..79135b6f 100644\n> >>>> --- a/Documentation/meson.build\n> >>>> +++ b/Documentation/meson.build\n> >>>> @@ -129,6 +129,7 @@ if sphinx.found()\n> >>>>            'conf.py',\n> >>>>            'contributing.rst',\n> >>>>            'docs.rst',\n> >>>> +        'documentation-contents.rst',\n> >>>>            'environment_variables.rst',\n> >>>>            'guides/application-developer.rst',\n> >>>>            'guides/introduction.rst',\n> >>>> diff --git a/Documentation/python-bindings.rst b/Documentation/python-bindings.rst\n> >>>> index ed9f686b..94712238 100644\n> >>>> --- a/Documentation/python-bindings.rst\n> >>>> +++ b/Documentation/python-bindings.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +.. include:: documentation-contents.rst\n> >>>> +\n> >>>>    .. _python-bindings:\n> >>>>    Python Bindings for libcamera\n> >>>> diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst\n> >>>> index 0e516b34..fb4269d0 100644\n> >>>> --- a/Documentation/sensor_driver_requirements.rst\n> >>>> +++ b/Documentation/sensor_driver_requirements.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +.. include:: documentation-contents.rst\n> >>>> +\n> >>>>    .. _sensor-driver-requirements:\n> >>>>    Sensor Driver Requirements\n> >>>> diff --git a/Documentation/software-isp-benchmarking.rst b/Documentation/software-isp-benchmarking.rst\n> >>>> index b3033132..9c2a409b 100644\n> >>>> --- a/Documentation/software-isp-benchmarking.rst\n> >>>> +++ b/Documentation/software-isp-benchmarking.rst\n> >>>> @@ -1,5 +1,7 @@\n> >>>>    .. SPDX-License-Identifier: CC-BY-SA-4.0\n> >>>> +.. include:: documentation-contents.rst\n> >>>> +\n> >>>>    .. _software-isp-benchmarking:\n> >>>>    Software ISP benchmarking\n> >>>> diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css\n> >>>> index d4274ea6..2b1ed095 100644\n> >>>> --- a/Documentation/theme/static/css/theme.css\n> >>>> +++ b/Documentation/theme/static/css/theme.css\n> >>>> @@ -289,3 +289,7 @@ div#signature {\n> >>>>    \tpadding: 0px;\n> >>>>    \tvisibility: hidden;\n> >>>>    }\n> >>>> +\n> >>>> +.documentation-nav {\n> >>>> +\tdisplay: none;\n> >>>> +}","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 3105CC323E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue, 20 Aug 2024 15:03:38 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id A3959633CE;\n\tTue, 20 Aug 2024 17:03:36 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id CA944633B2\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 20 Aug 2024 17:03:34 +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 6FAB54CC;\n\tTue, 20 Aug 2024 17:02:32 +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=\"lwfY8IS7\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1724166152;\n\tbh=+/Es6b7PybVIHLl95wHMqcexcScyNABT+3MsWsfFkXU=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=lwfY8IS7rROUBk9DWDq9+oUCUA/r+oFRZOra7XnYoKoYcpie71swzLaf0gs8qECXV\n\tXFLa5ep4VnanjicsRBU2fRbH+QwCIxVhlUXzAS9f/FGKN4WthTz3BPixPPa0H8JY1t\n\tFgONzTRXTysuXY/luD6qLrKfNXkuNOh0/kGAJRBE=","Date":"Tue, 20 Aug 2024 18:03:32 +0300","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"Dan Scally <dan.scally@ideasonboard.com>","Cc":"Stefan Klug <stefan.klug@ideasonboard.com>,\n\tlibcamera-devel@lists.libcamera.org","Subject":"Re: [PATCH v3 1/7] Documentation: Add documentation-contents.rst","Message-ID":"<20240820150332.GA12401@pendragon.ideasonboard.com>","References":"<20240819160921.468981-1-dan.scally@ideasonboard.com>\n\t<20240819160921.468981-2-dan.scally@ideasonboard.com>\n\t<nxbnj6qmcqmojyhms3gnrzifgozhrebt4xwnci4hahpfaxvxvj@4boy6buwzbu3>\n\t<76a940a7-8c8e-4108-b08c-cf84a5d1ef19@ideasonboard.com>\n\t<cqoynbor3jpxgai2hja4bjnjcikmjdckm2lzsjk6b7cz7t7esj@wjehkq5hjeyp>\n\t<6daf3228-fc93-4cb9-a019-ae52c85f13b7@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<6daf3228-fc93-4cb9-a019-ae52c85f13b7@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>"}}]