{"id":24339,"url":"https://patchwork.libcamera.org/api/patches/24339/?format=json","web_url":"https://patchwork.libcamera.org/patch/24339/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/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":"<20250911230115.25335-11-laurent.pinchart@ideasonboard.com>","date":"2025-09-11T23:01:11","name":"[v2,10/10] Documentation: Rename api to public-api and drop -html suffix","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"1b3a5ffbcb8c354a1f359f5abff58c9311f6c2ee","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/24339/mbox/","series":[{"id":5435,"url":"https://patchwork.libcamera.org/api/series/5435/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=5435","date":"2025-09-11T23:01:01","name":"Documentation theming update","version":2,"mbox":"https://patchwork.libcamera.org/series/5435/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/24339/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/24339/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 875ACC324E\n\tfor ;\n\tThu, 11 Sep 2025 23:02:04 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id CFC6269383;\n\tFri, 12 Sep 2025 01:02:03 +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 5BF696936F\n\tfor ;\n\tFri, 12 Sep 2025 01:02:02 +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 7135C46D5\n\tfor ;\n\tFri, 12 Sep 2025 01:00:47 +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=\"I1vEkfb9\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1757631647;\n\tbh=wcKCxkjBRmCL/SNZCp5mF/CwEtGRjtvJXbUsDI5AF3c=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=I1vEkfb9LPf1Lj61oYuoEyA9/SruS9jvwNIzpwPsbVkaRk1yAvLcsPPlElXYcC+Z+\n\tAg+zYitu5qUSj6SjEeKXqvxSt46iXVHUnNWajChcCwlZ2RnL+R+t9HEYzVlZtxaaY8\n\tLktFSddFtIuVFWaQ8qRFI4IukA20zXszaeYOsBks=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Subject":"[PATCH v2 10/10] Documentation: Rename api to public-api and drop\n\t-html suffix","Date":"Fri, 12 Sep 2025 02:01:11 +0300","Message-ID":"<20250911230115.25335-11-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.49.1","In-Reply-To":"<20250911230115.25335-1-laurent.pinchart@ideasonboard.com>","References":"<20250911230115.25335-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","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 public and internal Doxygen API documentation is compiled and\ninstalled in api-html and internal-api-html directories respectively.\nThe '-html' suffix doesn't provide any value, and the asymmetry between\nthe names can be confusing. Rename the directories to public-api and\ninternal-api respectively.\n\nSigned-off-by: Laurent Pinchart \n---\n Documentation/Doxyfile-internal.in | 4 ++--\n Documentation/Doxyfile-public.in | 4 ++--\n Documentation/conf.py.in | 16 ++++++++--------\n Documentation/index.rst | 4 ++--\n .../index.rst | 0\n Documentation/mainpage.dox | 4 ++--\n Documentation/meson.build | 8 ++++----\n Documentation/{api-html => public-api}/index.rst | 0\n 8 files changed, 20 insertions(+), 20 deletions(-)\n rename Documentation/{internal-api-html => internal-api}/index.rst (100%)\n rename Documentation/{api-html => public-api}/index.rst (100%)","diff":"diff --git a/Documentation/Doxyfile-internal.in b/Documentation/Doxyfile-internal.in\nindex aeaa06e9d9d3..b64b6a6feef3 100644\n--- a/Documentation/Doxyfile-internal.in\n+++ b/Documentation/Doxyfile-internal.in\n@@ -31,6 +31,6 @@ EXCLUDE = @TOP_SRCDIR@/include/libcamera/base/span.h \\\n @TOP_BUILDDIR@/include/libcamera/ipa/soft_ipa_interface.h \\\n @TOP_BUILDDIR@/src/libcamera/proxy/\n \n-HTML_OUTPUT = internal-api-html\n+HTML_OUTPUT = internal-api\n \n-GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml\n+GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/internal-api/tagfile.xml\ndiff --git a/Documentation/Doxyfile-public.in b/Documentation/Doxyfile-public.in\nindex 917f24008579..9efb2b341ab4 100644\n--- a/Documentation/Doxyfile-public.in\n+++ b/Documentation/Doxyfile-public.in\n@@ -16,8 +16,8 @@ EXCLUDE = @TOP_SRCDIR@/include/libcamera/base/class.h \\\n @TOP_SRCDIR@/src/libcamera/base/class.cpp \\\n @TOP_SRCDIR@/src/libcamera/base/object.cpp\n \n-HTML_OUTPUT = api-html\n+HTML_OUTPUT = public-api\n \n PREDEFINED += __DOXYGEN_PUBLIC__\n \n-GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/api-html/tagfile.xml\n+GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/public-api/tagfile.xml\ndiff --git a/Documentation/conf.py.in b/Documentation/conf.py.in\nindex 76f2e153f643..be9f7a570f8c 100644\n--- a/Documentation/conf.py.in\n+++ b/Documentation/conf.py.in\n@@ -69,23 +69,23 @@ pygments_style = None\n \n doxylink = {\n 'doxy-pub': (\n- '@TOP_BUILDDIR@/Documentation/api-html/tagfile.xml',\n- 'api-html/',\n+ '@TOP_BUILDDIR@/Documentation/public-api/tagfile.xml',\n+ 'public-api/',\n ),\n 'doxy-int': (\n- '@TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml',\n- 'internal-api-html/',\n+ '@TOP_BUILDDIR@/Documentation/internal-api/tagfile.xml',\n+ 'internal-api/',\n ),\n }\n \n doxygen_links = [\n [\n- '@TOP_BUILDDIR@/Documentation/html/api-html',\n- '@TOP_BUILDDIR@/Documentation/api-html',\n+ '@TOP_BUILDDIR@/Documentation/html/public-api',\n+ '@TOP_BUILDDIR@/Documentation/public-api',\n ],\n [\n- '@TOP_BUILDDIR@/Documentation/html/internal-api-html',\n- '@TOP_BUILDDIR@/Documentation/internal-api-html',\n+ '@TOP_BUILDDIR@/Documentation/html/internal-api',\n+ '@TOP_BUILDDIR@/Documentation/internal-api',\n ],\n ]\n \ndiff --git a/Documentation/index.rst b/Documentation/index.rst\nindex d55b5ff21464..7f762bbcc998 100644\n--- a/Documentation/index.rst\n+++ b/Documentation/index.rst\n@@ -11,7 +11,7 @@\n Application Writer's Guide \n Python Bindings \n Environment variables \n- Public API \n+ Public API \n \n .. toctree::\n :maxdepth: 1\n@@ -26,7 +26,7 @@\n SoftwareISP Benchmarking \n Tracing guide \n Design document: AE \n- Internal API \n+ Internal API \n \n .. toctree::\n :maxdepth: 1\ndiff --git a/Documentation/internal-api-html/index.rst b/Documentation/internal-api/index.rst\nsimilarity index 100%\nrename from Documentation/internal-api-html/index.rst\nrename to Documentation/internal-api/index.rst\ndiff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox\nindex fae99f28f1af..99e67e7ab13d 100644\n--- a/Documentation/mainpage.dox\n+++ b/Documentation/mainpage.dox\n@@ -20,7 +20,7 @@ your platform the [pipeline handler writer's guide](../guides/pipeline-handler.h\n and the [ipa module writer's guide](../guides/ipa.html) should be helpful.\n \n The full libcamera API is documented here. If you wish to see only the public\n-part of the API you can use [these pages](../api-html/index.html) instead.\n+part of the API you can use [these pages](../public-api/index.html) instead.\n \n \\else\n \n@@ -31,7 +31,7 @@ gives an overview on how to achieve that.\n Only the public part of the libcamera API is documented here; if you are a\n developer seeking to add support for your hardware to the library or make other\n improvements, you should switch to the internal API\n-[reference pages](../internal-api-html/index.html) instead.\n+[reference pages](../internal-api/index.html) instead.\n \n \\endif\n */\ndiff --git a/Documentation/meson.build b/Documentation/meson.build\nindex bedb37a8c8cf..d85428af1e40 100644\n--- a/Documentation/meson.build\n+++ b/Documentation/meson.build\n@@ -87,7 +87,7 @@ if doxygen.found() and dot.found()\n doxyfile,\n doxyfile_common,\n ],\n- output : 'api-html',\n+ output : 'public-api',\n command : [doxygen, doxyfile],\n install : true,\n install_dir : doc_install_dir / 'html',\n@@ -107,7 +107,7 @@ if doxygen.found() and dot.found()\n doxygen_public_input,\n doxygen_internal_input,\n ],\n- output : 'internal-api-html',\n+ output : 'internal-api',\n command : [doxygen, doxyfile],\n install : true,\n install_dir : doc_install_dir / 'html',\n@@ -154,7 +154,6 @@ if sphinx.found()\n sphinx_env.set('PYTHONDONTWRITEBYTECODE', '1')\n \n docs_sources = [\n- 'api-html/index.rst',\n 'camera-sensor-model.rst',\n 'code-of-conduct.rst',\n 'coding-style.rst',\n@@ -168,11 +167,12 @@ if sphinx.found()\n 'guides/pipeline-handler.rst',\n 'guides/tracing.rst',\n 'index.rst',\n- 'internal-api-html/index.rst',\n+ 'internal-api/index.rst',\n 'introduction.rst',\n 'lens_driver_requirements.rst',\n 'libcamera_architecture.rst',\n 'mali-c55.dot',\n+ 'public-api/index.rst',\n 'python-bindings.rst',\n 'sensor_driver_requirements.rst',\n 'software-isp-benchmarking.rst',\ndiff --git a/Documentation/api-html/index.rst b/Documentation/public-api/index.rst\nsimilarity index 100%\nrename from Documentation/api-html/index.rst\nrename to Documentation/public-api/index.rst\n","prefixes":["v2","10/10"]}