From patchwork Thu Sep 11 23:01:11 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 24339 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 875ACC324E for ; Thu, 11 Sep 2025 23:02:04 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id CFC6269383; Fri, 12 Sep 2025 01:02:03 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="I1vEkfb9"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 5BF696936F for ; Fri, 12 Sep 2025 01:02:02 +0200 (CEST) Received: from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi [81.175.209.231]) by perceval.ideasonboard.com (Postfix) with UTF8SMTPSA id 7135C46D5 for ; Fri, 12 Sep 2025 01:00:47 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1757631647; bh=wcKCxkjBRmCL/SNZCp5mF/CwEtGRjtvJXbUsDI5AF3c=; h=From:To:Subject:Date:In-Reply-To:References:From; b=I1vEkfb9LPf1Lj61oYuoEyA9/SruS9jvwNIzpwPsbVkaRk1yAvLcsPPlElXYcC+Z+ Ag+zYitu5qUSj6SjEeKXqvxSt46iXVHUnNWajChcCwlZ2RnL+R+t9HEYzVlZtxaaY8 LktFSddFtIuVFWaQ8qRFI4IukA20zXszaeYOsBks= From: Laurent Pinchart To: libcamera-devel@lists.libcamera.org Subject: [PATCH v2 10/10] Documentation: Rename api to public-api and drop -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 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The public and internal Doxygen API documentation is compiled and installed in api-html and internal-api-html directories respectively. The '-html' suffix doesn't provide any value, and the asymmetry between the names can be confusing. Rename the directories to public-api and internal-api respectively. Signed-off-by: Laurent Pinchart --- Documentation/Doxyfile-internal.in | 4 ++-- Documentation/Doxyfile-public.in | 4 ++-- Documentation/conf.py.in | 16 ++++++++-------- Documentation/index.rst | 4 ++-- .../index.rst | 0 Documentation/mainpage.dox | 4 ++-- Documentation/meson.build | 8 ++++---- Documentation/{api-html => public-api}/index.rst | 0 8 files changed, 20 insertions(+), 20 deletions(-) rename Documentation/{internal-api-html => internal-api}/index.rst (100%) rename Documentation/{api-html => public-api}/index.rst (100%) diff --git a/Documentation/Doxyfile-internal.in b/Documentation/Doxyfile-internal.in index aeaa06e9d9d3..b64b6a6feef3 100644 --- a/Documentation/Doxyfile-internal.in +++ b/Documentation/Doxyfile-internal.in @@ -31,6 +31,6 @@ EXCLUDE = @TOP_SRCDIR@/include/libcamera/base/span.h \ @TOP_BUILDDIR@/include/libcamera/ipa/soft_ipa_interface.h \ @TOP_BUILDDIR@/src/libcamera/proxy/ -HTML_OUTPUT = internal-api-html +HTML_OUTPUT = internal-api -GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml +GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/internal-api/tagfile.xml diff --git a/Documentation/Doxyfile-public.in b/Documentation/Doxyfile-public.in index 917f24008579..9efb2b341ab4 100644 --- a/Documentation/Doxyfile-public.in +++ b/Documentation/Doxyfile-public.in @@ -16,8 +16,8 @@ EXCLUDE = @TOP_SRCDIR@/include/libcamera/base/class.h \ @TOP_SRCDIR@/src/libcamera/base/class.cpp \ @TOP_SRCDIR@/src/libcamera/base/object.cpp -HTML_OUTPUT = api-html +HTML_OUTPUT = public-api PREDEFINED += __DOXYGEN_PUBLIC__ -GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/api-html/tagfile.xml +GENERATE_TAGFILE = @TOP_BUILDDIR@/Documentation/public-api/tagfile.xml diff --git a/Documentation/conf.py.in b/Documentation/conf.py.in index 76f2e153f643..be9f7a570f8c 100644 --- a/Documentation/conf.py.in +++ b/Documentation/conf.py.in @@ -69,23 +69,23 @@ pygments_style = None doxylink = { 'doxy-pub': ( - '@TOP_BUILDDIR@/Documentation/api-html/tagfile.xml', - 'api-html/', + '@TOP_BUILDDIR@/Documentation/public-api/tagfile.xml', + 'public-api/', ), 'doxy-int': ( - '@TOP_BUILDDIR@/Documentation/internal-api-html/tagfile.xml', - 'internal-api-html/', + '@TOP_BUILDDIR@/Documentation/internal-api/tagfile.xml', + 'internal-api/', ), } doxygen_links = [ [ - '@TOP_BUILDDIR@/Documentation/html/api-html', - '@TOP_BUILDDIR@/Documentation/api-html', + '@TOP_BUILDDIR@/Documentation/html/public-api', + '@TOP_BUILDDIR@/Documentation/public-api', ], [ - '@TOP_BUILDDIR@/Documentation/html/internal-api-html', - '@TOP_BUILDDIR@/Documentation/internal-api-html', + '@TOP_BUILDDIR@/Documentation/html/internal-api', + '@TOP_BUILDDIR@/Documentation/internal-api', ], ] diff --git a/Documentation/index.rst b/Documentation/index.rst index d55b5ff21464..7f762bbcc998 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -11,7 +11,7 @@ Application Writer's Guide Python Bindings Environment variables - Public API + Public API .. toctree:: :maxdepth: 1 @@ -26,7 +26,7 @@ SoftwareISP Benchmarking Tracing guide Design document: AE - Internal API + Internal API .. toctree:: :maxdepth: 1 diff --git a/Documentation/internal-api-html/index.rst b/Documentation/internal-api/index.rst similarity index 100% rename from Documentation/internal-api-html/index.rst rename to Documentation/internal-api/index.rst diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox index fae99f28f1af..99e67e7ab13d 100644 --- a/Documentation/mainpage.dox +++ b/Documentation/mainpage.dox @@ -20,7 +20,7 @@ your platform the [pipeline handler writer's guide](../guides/pipeline-handler.h and the [ipa module writer's guide](../guides/ipa.html) should be helpful. The full libcamera API is documented here. If you wish to see only the public -part of the API you can use [these pages](../api-html/index.html) instead. +part of the API you can use [these pages](../public-api/index.html) instead. \else @@ -31,7 +31,7 @@ gives an overview on how to achieve that. Only the public part of the libcamera API is documented here; if you are a developer seeking to add support for your hardware to the library or make other improvements, you should switch to the internal API -[reference pages](../internal-api-html/index.html) instead. +[reference pages](../internal-api/index.html) instead. \endif */ diff --git a/Documentation/meson.build b/Documentation/meson.build index bedb37a8c8cf..d85428af1e40 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -87,7 +87,7 @@ if doxygen.found() and dot.found() doxyfile, doxyfile_common, ], - output : 'api-html', + output : 'public-api', command : [doxygen, doxyfile], install : true, install_dir : doc_install_dir / 'html', @@ -107,7 +107,7 @@ if doxygen.found() and dot.found() doxygen_public_input, doxygen_internal_input, ], - output : 'internal-api-html', + output : 'internal-api', command : [doxygen, doxyfile], install : true, install_dir : doc_install_dir / 'html', @@ -154,7 +154,6 @@ if sphinx.found() sphinx_env.set('PYTHONDONTWRITEBYTECODE', '1') docs_sources = [ - 'api-html/index.rst', 'camera-sensor-model.rst', 'code-of-conduct.rst', 'coding-style.rst', @@ -168,11 +167,12 @@ if sphinx.found() 'guides/pipeline-handler.rst', 'guides/tracing.rst', 'index.rst', - 'internal-api-html/index.rst', + 'internal-api/index.rst', 'introduction.rst', 'lens_driver_requirements.rst', 'libcamera_architecture.rst', 'mali-c55.dot', + 'public-api/index.rst', 'python-bindings.rst', 'sensor_driver_requirements.rst', 'software-isp-benchmarking.rst', diff --git a/Documentation/api-html/index.rst b/Documentation/public-api/index.rst similarity index 100% rename from Documentation/api-html/index.rst rename to Documentation/public-api/index.rst