| Message ID | 20250917201742.16406-9-laurent.pinchart@ideasonboard.com |
|---|---|
| State | Accepted |
| Headers | show |
| Series |
|
| Related | show |
2025. 09. 17. 22:17 keltezéssel, Laurent Pinchart írta: > From: Stefan Klug <stefan.klug@ideasonboard.com> > > The libcamera.org documentation publishing process does not rely on a > particular structure of the documentation anymore. This makes > documentation-contents.rst unneeded. Drop it. > > Signed-off-by: Stefan Klug <stefan.klug@ideasonboard.com> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> > --- > Changes since v2: > > - Update commit message > > Changes since v1: > > - Remove html_css_files completely > --- > Documentation/camera-sensor-model.rst | 2 -- > Documentation/code-of-conduct.rst | 2 -- > Documentation/coding-style.rst | 2 -- > Documentation/conf.py.in | 7 +--- > Documentation/documentation-contents.rst | 35 ------------------- > Documentation/environment_variables.rst | 2 -- > Documentation/feature_requirements.rst | 2 -- > .../guides/application-developer.rst | 2 -- > Documentation/guides/ipa.rst | 2 -- > Documentation/guides/pipeline-handler.rst | 2 -- > Documentation/guides/tracing.rst | 2 -- > Documentation/introduction.rst | 2 -- > Documentation/lens_driver_requirements.rst | 2 -- > Documentation/libcamera_architecture.rst | 2 -- > Documentation/meson.build | 1 - > Documentation/python-bindings.rst | 2 -- > Documentation/sensor_driver_requirements.rst | 2 -- > Documentation/software-isp-benchmarking.rst | 2 -- > Documentation/theme/static/custom.css | 5 --- > 19 files changed, 1 insertion(+), 77 deletions(-) > delete mode 100644 Documentation/documentation-contents.rst > delete mode 100644 Documentation/theme/static/custom.css > > diff --git a/Documentation/camera-sensor-model.rst b/Documentation/camera-sensor-model.rst > index 87a25bf4a7fc..b66c880a5e00 100644 > --- a/Documentation/camera-sensor-model.rst > +++ b/Documentation/camera-sensor-model.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: documentation-contents.rst > - > .. _camera-sensor-model: > > .. todo: Move to Doxygen-generated documentation > diff --git a/Documentation/code-of-conduct.rst b/Documentation/code-of-conduct.rst > index 0edd1e9955e0..38b7d7ad679f 100644 > --- a/Documentation/code-of-conduct.rst > +++ b/Documentation/code-of-conduct.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-4.0 > > -.. include:: documentation-contents.rst > - > .. _code-of-conduct: > > Contributor Covenant Code of Conduct > diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst > index 6ac3a4a0d517..3352b75c76c8 100644 > --- a/Documentation/coding-style.rst > +++ b/Documentation/coding-style.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: documentation-contents.rst > - > .. _coding-style-guidelines: > > Coding Style Guidelines > diff --git a/Documentation/conf.py.in b/Documentation/conf.py.in > index 2c75a75799e6..349feda2a610 100644 > --- a/Documentation/conf.py.in > +++ b/Documentation/conf.py.in I think `documentation-contents.rst` should be removed from `exclude_patterns` as well. Reviewed-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com> > @@ -108,7 +108,7 @@ html_context = { > # Add any paths that contain custom static files (such as style sheets) here, > # relative to this directory. They are copied after the builtin static files, > # so a file named "default.css" will overwrite the builtin "default.css". > -html_static_path = ['@CURRENT_SRCDIR@/theme/static'] > +html_static_path = [] > > # Custom sidebar templates, must be a dictionary that maps document names > # to template names. > @@ -119,8 +119,3 @@ html_static_path = ['@CURRENT_SRCDIR@/theme/static'] > # 'searchbox.html']``. > # > # html_sidebars = {} > - > -html_css_files = [ > - 'custom.css', > -] > - > diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst > deleted file mode 100644 > index 5c1118493745..000000000000 > --- a/Documentation/documentation-contents.rst > +++ /dev/null > @@ -1,35 +0,0 @@ > -.. SPDX-License-Identifier: CC-BY-SA-4.0 > - > -.. container:: documentation-nav > - > - * **Documentation for Users** > - * :doc:`Introduction </introduction>` > - * :doc:`/feature_requirements` > - * :doc:`/guides/application-developer` > - * :doc:`/python-bindings` > - * :doc:`/environment_variables` > - * :doc:`/api-html/index` > - * :doc:`/code-of-conduct` > - * | > - * **Documentation for Developers** > - * :doc:`/libcamera_architecture` > - * :doc:`/guides/pipeline-handler` > - * :doc:`/guides/ipa` > - * :doc:`/camera-sensor-model` > - * :doc:`/guides/tracing` > - * :doc:`/software-isp-benchmarking` > - * :doc:`/coding-style` > - * :doc:`/internal-api-html/index` > - * | > - * **Documentation for System Integrators** > - * :doc:`/lens_driver_requirements` > - * :doc:`/sensor_driver_requirements` > - > -.. > - The following directive adds the "documentation" class to all of the pages > - generated by sphinx. This is not relevant in libcamera nor addressed in the > - theme's CSS, since all of the pages here are documentation. It **is** used > - to properly format the documentation pages on libcamera.org and so should not > - be removed. > - > -.. rst-class:: documentation > diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst > index 0cb4e27cd670..099769eab677 100644 > --- a/Documentation/environment_variables.rst > +++ b/Documentation/environment_variables.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: documentation-contents.rst > - > Environment variables > ===================== > > diff --git a/Documentation/feature_requirements.rst b/Documentation/feature_requirements.rst > index e6b74a62906a..1bceb3028cd0 100644 > --- a/Documentation/feature_requirements.rst > +++ b/Documentation/feature_requirements.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: documentation-contents.rst > - > Feature Requirements > ==================== > > diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst > index bccb54acc6d4..06c07d1e9449 100644 > --- a/Documentation/guides/application-developer.rst > +++ b/Documentation/guides/application-developer.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: ../documentation-contents.rst > - > Using libcamera in a C++ application > ==================================== > > diff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst > index cd640563a5f9..25deadefaf7c 100644 > --- a/Documentation/guides/ipa.rst > +++ b/Documentation/guides/ipa.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: ../documentation-contents.rst > - > IPA Writer's Guide > ================== > > diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst > index 2b866d98059c..85d9cc870021 100644 > --- a/Documentation/guides/pipeline-handler.rst > +++ b/Documentation/guides/pipeline-handler.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: ../documentation-contents.rst > - > Pipeline Handler Writers Guide > ============================== > > diff --git a/Documentation/guides/tracing.rst b/Documentation/guides/tracing.rst > index 537dce500338..ae960d85c075 100644 > --- a/Documentation/guides/tracing.rst > +++ b/Documentation/guides/tracing.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: ../documentation-contents.rst > - > Tracing Guide > ============= > > diff --git a/Documentation/introduction.rst b/Documentation/introduction.rst > index d76cebd05ee1..07b3a27ed007 100644 > --- a/Documentation/introduction.rst > +++ b/Documentation/introduction.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: documentation-contents.rst > - > ************ > Introduction > ************ > diff --git a/Documentation/lens_driver_requirements.rst b/Documentation/lens_driver_requirements.rst > index 85fef76f2580..b96e502d5da6 100644 > --- a/Documentation/lens_driver_requirements.rst > +++ b/Documentation/lens_driver_requirements.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: documentation-contents.rst > - > .. _lens-driver-requirements: > > Lens Driver Requirements > diff --git a/Documentation/libcamera_architecture.rst b/Documentation/libcamera_architecture.rst > index d2bd13e1dc39..ee67102a30a6 100644 > --- a/Documentation/libcamera_architecture.rst > +++ b/Documentation/libcamera_architecture.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: documentation-contents.rst > - > libcamera Architecture > ====================== > > diff --git a/Documentation/meson.build b/Documentation/meson.build > index 022770968fcf..54c32e249e45 100644 > --- a/Documentation/meson.build > +++ b/Documentation/meson.build > @@ -157,7 +157,6 @@ if sphinx.found() > sphinx_conf, > 'contributing.rst', > 'design/ae.rst', > - 'documentation-contents.rst', > 'environment_variables.rst', > 'feature_requirements.rst', > 'guides/application-developer.rst', > diff --git a/Documentation/python-bindings.rst b/Documentation/python-bindings.rst > index 947122384c88..ed9f686b311a 100644 > --- a/Documentation/python-bindings.rst > +++ b/Documentation/python-bindings.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: documentation-contents.rst > - > .. _python-bindings: > > Python Bindings for libcamera > diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst > index fb4269d039a2..0e516b34a215 100644 > --- a/Documentation/sensor_driver_requirements.rst > +++ b/Documentation/sensor_driver_requirements.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: documentation-contents.rst > - > .. _sensor-driver-requirements: > > Sensor Driver Requirements > diff --git a/Documentation/software-isp-benchmarking.rst b/Documentation/software-isp-benchmarking.rst > index 9c2a409b140f..b303313210e8 100644 > --- a/Documentation/software-isp-benchmarking.rst > +++ b/Documentation/software-isp-benchmarking.rst > @@ -1,7 +1,5 @@ > .. SPDX-License-Identifier: CC-BY-SA-4.0 > > -.. include:: documentation-contents.rst > - > .. _software-isp-benchmarking: > > Software ISP benchmarking > diff --git a/Documentation/theme/static/custom.css b/Documentation/theme/static/custom.css > deleted file mode 100644 > index 0be62294490a..000000000000 > --- a/Documentation/theme/static/custom.css > +++ /dev/null > @@ -1,5 +0,0 @@ > -/* SPDX-License-Identifier: CC-BY-SA-4.0 */ > -/* Hide the documentation nav. It is only used on the website. */ > -.documentation-nav { > - display: none; > -}
diff --git a/Documentation/camera-sensor-model.rst b/Documentation/camera-sensor-model.rst index 87a25bf4a7fc..b66c880a5e00 100644 --- a/Documentation/camera-sensor-model.rst +++ b/Documentation/camera-sensor-model.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: documentation-contents.rst - .. _camera-sensor-model: .. todo: Move to Doxygen-generated documentation diff --git a/Documentation/code-of-conduct.rst b/Documentation/code-of-conduct.rst index 0edd1e9955e0..38b7d7ad679f 100644 --- a/Documentation/code-of-conduct.rst +++ b/Documentation/code-of-conduct.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-4.0 -.. include:: documentation-contents.rst - .. _code-of-conduct: Contributor Covenant Code of Conduct diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst index 6ac3a4a0d517..3352b75c76c8 100644 --- a/Documentation/coding-style.rst +++ b/Documentation/coding-style.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: documentation-contents.rst - .. _coding-style-guidelines: Coding Style Guidelines diff --git a/Documentation/conf.py.in b/Documentation/conf.py.in index 2c75a75799e6..349feda2a610 100644 --- a/Documentation/conf.py.in +++ b/Documentation/conf.py.in @@ -108,7 +108,7 @@ html_context = { # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['@CURRENT_SRCDIR@/theme/static'] +html_static_path = [] # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -119,8 +119,3 @@ html_static_path = ['@CURRENT_SRCDIR@/theme/static'] # 'searchbox.html']``. # # html_sidebars = {} - -html_css_files = [ - 'custom.css', -] - diff --git a/Documentation/documentation-contents.rst b/Documentation/documentation-contents.rst deleted file mode 100644 index 5c1118493745..000000000000 --- a/Documentation/documentation-contents.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-4.0 - -.. container:: documentation-nav - - * **Documentation for Users** - * :doc:`Introduction </introduction>` - * :doc:`/feature_requirements` - * :doc:`/guides/application-developer` - * :doc:`/python-bindings` - * :doc:`/environment_variables` - * :doc:`/api-html/index` - * :doc:`/code-of-conduct` - * | - * **Documentation for Developers** - * :doc:`/libcamera_architecture` - * :doc:`/guides/pipeline-handler` - * :doc:`/guides/ipa` - * :doc:`/camera-sensor-model` - * :doc:`/guides/tracing` - * :doc:`/software-isp-benchmarking` - * :doc:`/coding-style` - * :doc:`/internal-api-html/index` - * | - * **Documentation for System Integrators** - * :doc:`/lens_driver_requirements` - * :doc:`/sensor_driver_requirements` - -.. - The following directive adds the "documentation" class to all of the pages - generated by sphinx. This is not relevant in libcamera nor addressed in the - theme's CSS, since all of the pages here are documentation. It **is** used - to properly format the documentation pages on libcamera.org and so should not - be removed. - -.. rst-class:: documentation diff --git a/Documentation/environment_variables.rst b/Documentation/environment_variables.rst index 0cb4e27cd670..099769eab677 100644 --- a/Documentation/environment_variables.rst +++ b/Documentation/environment_variables.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: documentation-contents.rst - Environment variables ===================== diff --git a/Documentation/feature_requirements.rst b/Documentation/feature_requirements.rst index e6b74a62906a..1bceb3028cd0 100644 --- a/Documentation/feature_requirements.rst +++ b/Documentation/feature_requirements.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: documentation-contents.rst - Feature Requirements ==================== diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst index bccb54acc6d4..06c07d1e9449 100644 --- a/Documentation/guides/application-developer.rst +++ b/Documentation/guides/application-developer.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: ../documentation-contents.rst - Using libcamera in a C++ application ==================================== diff --git a/Documentation/guides/ipa.rst b/Documentation/guides/ipa.rst index cd640563a5f9..25deadefaf7c 100644 --- a/Documentation/guides/ipa.rst +++ b/Documentation/guides/ipa.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: ../documentation-contents.rst - IPA Writer's Guide ================== diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst index 2b866d98059c..85d9cc870021 100644 --- a/Documentation/guides/pipeline-handler.rst +++ b/Documentation/guides/pipeline-handler.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: ../documentation-contents.rst - Pipeline Handler Writers Guide ============================== diff --git a/Documentation/guides/tracing.rst b/Documentation/guides/tracing.rst index 537dce500338..ae960d85c075 100644 --- a/Documentation/guides/tracing.rst +++ b/Documentation/guides/tracing.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: ../documentation-contents.rst - Tracing Guide ============= diff --git a/Documentation/introduction.rst b/Documentation/introduction.rst index d76cebd05ee1..07b3a27ed007 100644 --- a/Documentation/introduction.rst +++ b/Documentation/introduction.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: documentation-contents.rst - ************ Introduction ************ diff --git a/Documentation/lens_driver_requirements.rst b/Documentation/lens_driver_requirements.rst index 85fef76f2580..b96e502d5da6 100644 --- a/Documentation/lens_driver_requirements.rst +++ b/Documentation/lens_driver_requirements.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: documentation-contents.rst - .. _lens-driver-requirements: Lens Driver Requirements diff --git a/Documentation/libcamera_architecture.rst b/Documentation/libcamera_architecture.rst index d2bd13e1dc39..ee67102a30a6 100644 --- a/Documentation/libcamera_architecture.rst +++ b/Documentation/libcamera_architecture.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: documentation-contents.rst - libcamera Architecture ====================== diff --git a/Documentation/meson.build b/Documentation/meson.build index 022770968fcf..54c32e249e45 100644 --- a/Documentation/meson.build +++ b/Documentation/meson.build @@ -157,7 +157,6 @@ if sphinx.found() sphinx_conf, 'contributing.rst', 'design/ae.rst', - 'documentation-contents.rst', 'environment_variables.rst', 'feature_requirements.rst', 'guides/application-developer.rst', diff --git a/Documentation/python-bindings.rst b/Documentation/python-bindings.rst index 947122384c88..ed9f686b311a 100644 --- a/Documentation/python-bindings.rst +++ b/Documentation/python-bindings.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: documentation-contents.rst - .. _python-bindings: Python Bindings for libcamera diff --git a/Documentation/sensor_driver_requirements.rst b/Documentation/sensor_driver_requirements.rst index fb4269d039a2..0e516b34a215 100644 --- a/Documentation/sensor_driver_requirements.rst +++ b/Documentation/sensor_driver_requirements.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: documentation-contents.rst - .. _sensor-driver-requirements: Sensor Driver Requirements diff --git a/Documentation/software-isp-benchmarking.rst b/Documentation/software-isp-benchmarking.rst index 9c2a409b140f..b303313210e8 100644 --- a/Documentation/software-isp-benchmarking.rst +++ b/Documentation/software-isp-benchmarking.rst @@ -1,7 +1,5 @@ .. SPDX-License-Identifier: CC-BY-SA-4.0 -.. include:: documentation-contents.rst - .. _software-isp-benchmarking: Software ISP benchmarking diff --git a/Documentation/theme/static/custom.css b/Documentation/theme/static/custom.css deleted file mode 100644 index 0be62294490a..000000000000 --- a/Documentation/theme/static/custom.css +++ /dev/null @@ -1,5 +0,0 @@ -/* SPDX-License-Identifier: CC-BY-SA-4.0 */ -/* Hide the documentation nav. It is only used on the website. */ -.documentation-nav { - display: none; -}