[v3,10/10] Documentation: Rename api to public-api and drop -html suffix
diff mbox series

Message ID 20250917201742.16406-11-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • Documentation theming update
Related show

Commit Message

Laurent Pinchart Sept. 17, 2025, 8:17 p.m. UTC
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>
---
 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%)

Comments

Stefan Klug Sept. 18, 2025, 7:27 a.m. UTC | #1
Hi Laurent,

Thank you for the patch.

Quoting Laurent Pinchart (2025-09-17 22:17:41)
> 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>

Looks good to me.
Reviewed-by: Stefan Klug <stefan.klug@ideasonboard.com>

Regards,
Stefan

> ---
>  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 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 349feda2a610..3054454b809c 100644
> --- a/Documentation/conf.py.in
> +++ b/Documentation/conf.py.in
> @@ -74,12 +74,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 d55b5ff21464..7f762bbcc998 100644
> --- a/Documentation/index.rst
> +++ b/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
> 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 54c32e249e45..a5d8c20c30f9 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
> -- 
> Regards,
> 
> Laurent Pinchart
>
Barnabás Pőcze Sept. 18, 2025, 7:34 a.m. UTC | #2
2025. 09. 17. 22:17 keltezéssel, Laurent Pinchart írta:
> 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: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>


>   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 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 349feda2a610..3054454b809c 100644
> --- a/Documentation/conf.py.in
> +++ b/Documentation/conf.py.in
> @@ -74,12 +74,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 d55b5ff21464..7f762bbcc998 100644
> --- a/Documentation/index.rst
> +++ b/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
> 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 54c32e249e45..a5d8c20c30f9 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

Patch
diff mbox series

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 349feda2a610..3054454b809c 100644
--- a/Documentation/conf.py.in
+++ b/Documentation/conf.py.in
@@ -74,12 +74,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 d55b5ff21464..7f762bbcc998 100644
--- a/Documentation/index.rst
+++ b/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
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 54c32e249e45..a5d8c20c30f9 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