{"id":24149,"url":"https://patchwork.libcamera.org/api/1.1/patches/24149/?format=json","web_url":"https://patchwork.libcamera.org/patch/24149/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20250815143905.2247112-1-barnabas.pocze@ideasonboard.com>","date":"2025-08-15T14:39:05","name":"[RFC,v2] Documentation: Fix documentation generation when subproject","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"75776621efa3ca358a3def7275471cb205519aeb","submitter":{"id":216,"url":"https://patchwork.libcamera.org/api/1.1/people/216/?format=json","name":"Barnabás Pőcze","email":"barnabas.pocze@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/24149/mbox/","series":[{"id":5389,"url":"https://patchwork.libcamera.org/api/1.1/series/5389/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=5389","date":"2025-08-15T14:39:05","name":"[RFC,v2] Documentation: Fix documentation generation when subproject","version":2,"mbox":"https://patchwork.libcamera.org/series/5389/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/24149/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/24149/checks/","tags":{},"headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 90F1EBDCC1\n\tfor ;\n\tFri, 15 Aug 2025 14:39:11 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 473BD69259;\n\tFri, 15 Aug 2025 16:39:11 +0200 (CEST)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 979D661443\n\tfor ;\n\tFri, 15 Aug 2025 16:39:09 +0200 (CEST)","from pb-laptop.local (185.221.141.188.nat.pool.zt.hu\n\t[185.221.141.188])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 7A0DE56D;\n\tFri, 15 Aug 2025 16:38:14 +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=\"S6BKx6JC\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1755268694;\n\tbh=oME7AnFq5Cke6Mhjv4sHYfP57Bjkum5WRco8oifXkys=;\n\th=From:To:Cc:Subject:Date:From;\n\tb=S6BKx6JCXu3nKtoVh4PPqH3/J0/ZjaQ4d5VqfOPq0iTqWueFOpakfTOdXMU5tRSuZ\n\tcQxC+5KDVyIILMS6vpJd+lrOB4AkaIho+sjERe71Fush/I+5S5tUmpYjLxFzzmlYmj\n\tFik3F3PZIa7ZIzuRnRklcD/c8slbfizkZq7OlicY=","From":"=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= ","To":"libcamera-devel@lists.libcamera.org","Cc":"Laurent Pinchart ","Subject":"[RFC PATCH v2] Documentation: Fix documentation generation when\n\tsubproject","Date":"Fri, 15 Aug 2025 16:39:05 +0200","Message-ID":"<20250815143905.2247112-1-barnabas.pocze@ideasonboard.com>","X-Mailer":"git-send-email 2.50.1","MIME-Version":"1.0","Content-Type":"text/plain; charset=UTF-8","Content-Transfer-Encoding":"8bit","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"The paths of the doxygen tag files for sphinxcontrib-doxygen must be\nabsolute or relative the the current working directory. However, when\nlibcamera is built as a subproject, the current working directory\nis the top-level build directory. Thus the paths for the tag files\nwill not be correct.\n\nFix that by using `configure_file()` to generate the final sphinx\nconfiguration with the appropriate paths queried from meson.\n\nFixes: 0382d215d (\"Documentation: Use Sphinx doxylink to generate links to doxygen\")\nSigned-off-by: Barnabás Pőcze \nReviewed-by: Laurent Pinchart \n---\nchanges in v2:\n\t* variables in alphabetical order\n\t* import 'fs' module explicitly\n\nv1: https://patchwork.libcamera.org/patch/24044/\n---\n Documentation/{conf.py => conf.py.in} | 6 +++---\n Documentation/meson.build | 17 +++++++++++++++--\n 2 files changed, 18 insertions(+), 5 deletions(-)\n rename Documentation/{conf.py => conf.py.in} (95%)\n\n--\n2.50.1","diff":"diff --git a/Documentation/conf.py b/Documentation/conf.py.in\nsimilarity index 95%\nrename from Documentation/conf.py\nrename to Documentation/conf.py.in\nindex f50be60a1..097e579b5 100644\n--- a/Documentation/conf.py\n+++ b/Documentation/conf.py.in\n@@ -74,11 +74,11 @@ pygments_style = None\n\n doxylink = {\n 'doxy-pub': (\n- 'Documentation/api-html/tagfile.xml',\n+ '@TOP_BUILDDIR@/Documentation/api-html/tagfile.xml',\n '../api-html/',\n ),\n 'doxy-int': (\n- 'Documentation/internal-api-html/tagfile.xml',\n+ '@TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml',\n '../internal-api-html/',\n ),\n }\n@@ -89,7 +89,7 @@ doxylink = {\n # a list of builtin themes.\n #\n html_theme = 'theme'\n-html_theme_path = ['.']\n+html_theme_path = ['@THEME_DIR@']\n\n # Theme options are theme-specific and customize the look and feel of a theme\n # further. For a list of options available for each theme, see the\ndiff --git a/Documentation/meson.build b/Documentation/meson.build\nindex b898ba3a0..10aaf613e 100644\n--- a/Documentation/meson.build\n+++ b/Documentation/meson.build\n@@ -142,11 +142,21 @@ if sphinx.found()\n .format(mod, version, min_version))\n endif\n\n+ sphinx_conf = configure_file(input : 'conf.py.in',\n+ output : 'conf.py',\n+ configuration : {\n+ 'THEME_DIR': meson.current_source_dir(),\n+ 'TOP_BUILDDIR': meson.project_build_root(),\n+ })\n+\n+ fs = import('fs')\n+ sphinx_conf_dir = fs.parent(sphinx_conf)\n+\n docs_sources = [\n 'camera-sensor-model.rst',\n 'code-of-conduct.rst',\n 'coding-style.rst',\n- 'conf.py',\n+ sphinx_conf,\n 'contributing.rst',\n 'design/ae.rst',\n 'documentation-contents.rst',\n@@ -171,6 +181,7 @@ if sphinx.found()\n\n custom_target('documentation',\n command : [sphinx, '-D', release, '-q', '-W', '-b', 'html',\n+ '-c', sphinx_conf_dir,\n meson.current_source_dir(), '@OUTPUT@'],\n input : docs_sources,\n output : 'html',\n@@ -184,7 +195,9 @@ if sphinx.found()\n install_tag : 'doc')\n\n custom_target('documentation-linkcheck',\n- command : [sphinx, '-W', '-b', 'linkcheck', meson.current_source_dir(), '@OUTPUT@'],\n+ command : [sphinx, '-W', '-b', 'linkcheck',\n+ '-c', sphinx_conf_dir,\n+ meson.current_source_dir(), '@OUTPUT@'],\n build_always_stale : true,\n input : docs_sources,\n output : 'linkcheck')\n","prefixes":["RFC","v2"]}