Documentation: Rename api to public-api and drop -html suffix

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 <laurent.pinchart@ideasonboard.com>
Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com>
Reviewed-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>

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

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

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/',
     ),
 }
 

Documentation/index.rst

@@ -11,7 +11,7 @@
    Application Writer's Guide <guides/application-developer>
    Python Bindings <python-bindings>
    Environment variables <environment_variables>
-   Public API <api-html/index>
+   Public API <public-api/index>
 
 .. toctree::
    :maxdepth: 1
@@ -26,7 +26,7 @@
    SoftwareISP Benchmarking <software-isp-benchmarking>
    Tracing guide <guides/tracing>
    Design document: AE <design/ae>
-   Internal API <internal-api-html/index>
+   Internal API <internal-api/index>
 
 .. toctree::
    :maxdepth: 1

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
 */

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',