[{"id":35771,"web_url":"https://patchwork.libcamera.org/comment/35771/","msgid":"<20250910172931.GJ20904@pendragon.ideasonboard.com>","date":"2025-09-10T17:29:31","subject":"Re: [PATCH 6/6] documentation: Drop unnecessary\n\tdocumentation-contents.rst","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Stefan,\n\nThank you for the patch.\n\nOn Mon, Sep 08, 2025 at 04:07:49PM +0200, Stefan Klug wrote:\n> Now that the documentation is separate from the website, we don't need\n> documentation-contents.rst anymore. Drop it.\n> \n> Signed-off-by: Stefan Klug <stefan.klug@ideasonboard.com>\n\nReviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\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.in                      |  6 ++--\n>  Documentation/documentation-contents.rst      | 35 -------------------\n>  Documentation/environment_variables.rst       |  2 --\n>  Documentation/feature_requirements.rst        |  2 --\n>  .../guides/application-developer.rst          |  2 --\n>  Documentation/guides/ipa.rst                  |  2 --\n>  Documentation/guides/pipeline-handler.rst     |  2 --\n>  Documentation/guides/tracing.rst              |  2 --\n>  Documentation/introduction.rst                |  2 --\n>  Documentation/lens_driver_requirements.rst    |  2 --\n>  Documentation/libcamera_architecture.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/custom.css         |  5 ---\n>  19 files changed, 2 insertions(+), 75 deletions(-)\n>  delete mode 100644 Documentation/documentation-contents.rst\n>  delete mode 100644 Documentation/theme/static/custom.css\n> \n> diff --git a/Documentation/camera-sensor-model.rst b/Documentation/camera-sensor-model.rst\n> index 87a25bf4a7fc..b66c880a5e00 100644\n> --- a/Documentation/camera-sensor-model.rst\n> +++ b/Documentation/camera-sensor-model.rst\n> @@ -1,7 +1,5 @@\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 0edd1e9955e0..38b7d7ad679f 100644\n> --- a/Documentation/code-of-conduct.rst\n> +++ b/Documentation/code-of-conduct.rst\n> @@ -1,7 +1,5 @@\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 6ac3a4a0d517..3352b75c76c8 100644\n> --- a/Documentation/coding-style.rst\n> +++ b/Documentation/coding-style.rst\n> @@ -1,7 +1,5 @@\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.in b/Documentation/conf.py.in\n> index c772f643fb7c..a4fa05567233 100644\n> --- a/Documentation/conf.py.in\n> +++ b/Documentation/conf.py.in\n> @@ -108,7 +108,7 @@ html_context = {\n>  # Add any paths that contain custom static files (such as style sheets) here,\n>  # relative to this directory. They are copied after the builtin static files,\n>  # so a file named \"default.css\" will overwrite the builtin \"default.css\".\n> -html_static_path = ['@CURRENT_SRCDIR@/theme/static']\n> +html_static_path = []\n>  \n>  # Custom sidebar templates, must be a dictionary that maps document names\n>  # to template names.\n> @@ -120,7 +120,5 @@ html_static_path = ['@CURRENT_SRCDIR@/theme/static']\n>  #\n>  # html_sidebars = {}\n>  \n> -html_css_files = [\n> -    'custom.css',\n> -]\n> +html_css_files = []\n>  \n> diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst\n> deleted file mode 100644\n> index 5c1118493745..000000000000\n> --- a/Documentation/documentation-contents.rst\n> +++ /dev/null\n> @@ -1,35 +0,0 @@\n> -.. SPDX-License-Identifier: CC-BY-SA-4.0\n> -\n> -.. container:: documentation-nav\n> -\n> -   * **Documentation for Users**\n> -   * :doc:`Introduction </introduction>`\n> -   * :doc:`/feature_requirements`\n> -   * :doc:`/guides/application-developer`\n> -   * :doc:`/python-bindings`\n> -   * :doc:`/environment_variables`\n> -   * :doc:`/api-html/index`\n> -   * :doc:`/code-of-conduct`\n> -   * |\n> -   * **Documentation for Developers**\n> -   * :doc:`/libcamera_architecture`\n> -   * :doc:`/guides/pipeline-handler`\n> -   * :doc:`/guides/ipa`\n> -   * :doc:`/camera-sensor-model`\n> -   * :doc:`/guides/tracing`\n> -   * :doc:`/software-isp-benchmarking`\n> -   * :doc:`/coding-style`\n> -   * :doc:`/internal-api-html/index`\n> -   * |\n> -   * **Documentation for System Integrators**\n> -   * :doc:`/lens_driver_requirements`\n> -   * :doc:`/sensor_driver_requirements`\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 0cb4e27cd670..099769eab677 100644\n> --- a/Documentation/environment_variables.rst\n> +++ b/Documentation/environment_variables.rst\n> @@ -1,7 +1,5 @@\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/feature_requirements.rst b/Documentation/feature_requirements.rst\n> index e6b74a62906a..1bceb3028cd0 100644\n> --- a/Documentation/feature_requirements.rst\n> +++ b/Documentation/feature_requirements.rst\n> @@ -1,7 +1,5 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> -.. include:: documentation-contents.rst\n> -\n>  Feature Requirements\n>  ====================\n>  \n> diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst\n> index bccb54acc6d4..06c07d1e9449 100644\n> --- a/Documentation/guides/application-developer.rst\n> +++ b/Documentation/guides/application-developer.rst\n> @@ -1,7 +1,5 @@\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/ipa.rst b/Documentation/guides/ipa.rst\n> index cd640563a5f9..25deadefaf7c 100644\n> --- a/Documentation/guides/ipa.rst\n> +++ b/Documentation/guides/ipa.rst\n> @@ -1,7 +1,5 @@\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 2b866d98059c..85d9cc870021 100644\n> --- a/Documentation/guides/pipeline-handler.rst\n> +++ b/Documentation/guides/pipeline-handler.rst\n> @@ -1,7 +1,5 @@\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 537dce500338..ae960d85c075 100644\n> --- a/Documentation/guides/tracing.rst\n> +++ b/Documentation/guides/tracing.rst\n> @@ -1,7 +1,5 @@\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/introduction.rst b/Documentation/introduction.rst\n> index d76cebd05ee1..07b3a27ed007 100644\n> --- a/Documentation/introduction.rst\n> +++ b/Documentation/introduction.rst\n> @@ -1,7 +1,5 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> -.. include:: documentation-contents.rst\n> -\n>  ************\n>  Introduction\n>  ************\n> diff --git a/Documentation/lens_driver_requirements.rst b/Documentation/lens_driver_requirements.rst\n> index 85fef76f2580..b96e502d5da6 100644\n> --- a/Documentation/lens_driver_requirements.rst\n> +++ b/Documentation/lens_driver_requirements.rst\n> @@ -1,7 +1,5 @@\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/libcamera_architecture.rst b/Documentation/libcamera_architecture.rst\n> index d2bd13e1dc39..ee67102a30a6 100644\n> --- a/Documentation/libcamera_architecture.rst\n> +++ b/Documentation/libcamera_architecture.rst\n> @@ -1,7 +1,5 @@\n>  .. SPDX-License-Identifier: CC-BY-SA-4.0\n>  \n> -.. include:: documentation-contents.rst\n> -\n>  libcamera Architecture\n>  ======================\n>  \n> diff --git a/Documentation/meson.build b/Documentation/meson.build\n> index f9d17935749f..ffc4f81793a2 100644\n> --- a/Documentation/meson.build\n> +++ b/Documentation/meson.build\n> @@ -158,7 +158,6 @@ if sphinx.found()\n>          sphinx_conf,\n>          'contributing.rst',\n>          'design/ae.rst',\n> -        'documentation-contents.rst',\n>          'environment_variables.rst',\n>          'feature_requirements.rst',\n>          'guides/application-developer.rst',\n> diff --git a/Documentation/python-bindings.rst b/Documentation/python-bindings.rst\n> index 947122384c88..ed9f686b311a 100644\n> --- a/Documentation/python-bindings.rst\n> +++ b/Documentation/python-bindings.rst\n> @@ -1,7 +1,5 @@\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 fb4269d039a2..0e516b34a215 100644\n> --- a/Documentation/sensor_driver_requirements.rst\n> +++ b/Documentation/sensor_driver_requirements.rst\n> @@ -1,7 +1,5 @@\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 9c2a409b140f..b303313210e8 100644\n> --- a/Documentation/software-isp-benchmarking.rst\n> +++ b/Documentation/software-isp-benchmarking.rst\n> @@ -1,7 +1,5 @@\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/custom.css b/Documentation/theme/static/custom.css\n> deleted file mode 100644\n> index c409f3670e1c..000000000000\n> --- a/Documentation/theme/static/custom.css\n> +++ /dev/null\n> @@ -1,5 +0,0 @@\n> -\n> -/* Hide the documentation nav. It is only used on the website. */\n> -.documentation-nav {\n> -\tdisplay: none;\n> -}\n> \\ No newline at end of file","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 AEE24C324E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 10 Sep 2025 17:29:57 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 83A746936F;\n\tWed, 10 Sep 2025 19:29:56 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 9024F69357\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 10 Sep 2025 19:29:54 +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 UTF8SMTPSA id 290FB8BF;\n\tWed, 10 Sep 2025 19:28:40 +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=\"G4xQ6GLk\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1757525320;\n\tbh=Zs5L3wJHkjlgRLHds7jIgONKPFWTeKuNs9gtBFiD4cI=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=G4xQ6GLkW5HovhmGwhe+sxdKJjM9osTFVzszJcWcRe8San9+KjVPrdPuWkZ52egB5\n\tEbZ1qn0E+5kiLCDhjobW3hQQW+s0b8T2hnShDaooYyHjiCVYQSqGnNwzSx4O9CkmNr\n\tpXvqCJ+iMJFKME4KH5AV+J7NvJMJUSkLi0YFA7/Q=","Date":"Wed, 10 Sep 2025 20:29:31 +0300","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"Stefan Klug <stefan.klug@ideasonboard.com>","Cc":"libcamera-devel@lists.libcamera.org","Subject":"Re: [PATCH 6/6] documentation: Drop unnecessary\n\tdocumentation-contents.rst","Message-ID":"<20250910172931.GJ20904@pendragon.ideasonboard.com>","References":"<20250908140803.123272-1-stefan.klug@ideasonboard.com>\n\t<20250908140803.123272-7-stefan.klug@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20250908140803.123272-7-stefan.klug@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>"}}]