From d35802093293d76aa4f46c5109efdaddb41a40b3 Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Fri, 12 Sep 2025 01:30:23 +0300 Subject: [PATCH] Documentation: Rename api to public-api and drop -html suffix MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Stefan Klug Reviewed-by: Barnabás Pőcze --- Documentation/Doxyfile-internal.in | 4 ++-- Documentation/Doxyfile-public.in | 4 ++-- Documentation/conf.py.in | 8 ++++---- Documentation/index.rst | 4 ++-- .../{internal-api-html => internal-api}/index.rst | 0 Documentation/mainpage.dox | 4 ++-- Documentation/meson.build | 10 +++++----- Documentation/{api-html => public-api}/index.rst | 0 8 files changed, 17 insertions(+), 17 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 aeaa06e9..b64b6a6f 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 917f2400..9efb2b34 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 ee538174..79321b27 100644 --- a/Documentation/conf.py.in +++ b/Documentation/conf.py.in @@ -73,12 +73,12 @@ 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/', ), } diff --git a/Documentation/index.rst b/Documentation/index.rst index d55b5ff2..7f762bbc 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 fae99f28..99e67e7a 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 54c32e24..a5d8c20c 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -86,7 +86,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, @@ -106,7 +106,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, @@ -150,7 +150,6 @@ if sphinx.found() sphinx_conf_dir = fs.parent(sphinx_conf) docs_sources = [ - 'api-html/index.rst', 'camera-sensor-model.rst', 'code-of-conduct.rst', 'coding-style.rst', @@ -164,11 +163,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', @@ -193,7 +193,7 @@ if sphinx.found() install_tag : 'doc') meson.add_install_script('install-doxygen.sh', doc_install_dir, - 'api-html', 'internal-api-html') + 'public-api', 'internal-api') custom_target('documentation-linkcheck', command : [sphinx, '-W', '-b', 'linkcheck', 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