From c54eec09db1ba139dac8b3eddb8e3b4ac8ba40e0 Mon Sep 17 00:00:00 2001 From: Stefan Klug Date: Mon, 8 Sep 2025 16:07:49 +0200 Subject: [PATCH] Documentation: Drop unnecessary documentation-contents.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Signed-off-by: Laurent Pinchart Reviewed-by: Barnabás Pőcze --- Documentation/camera-sensor-model.rst | 2 -- Documentation/code-of-conduct.rst | 2 -- Documentation/coding-style.rst | 2 -- Documentation/conf.py.in | 8 +---- 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(+), 78 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 87a25bf4..b66c880a 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 0edd1e99..38b7d7ad 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 6ac3a4a0..3352b75c 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 2c75a757..ee538174 100644 --- a/Documentation/conf.py.in +++ b/Documentation/conf.py.in @@ -66,7 +66,6 @@ language = 'en' # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [ - 'documentation-contents.rst', ] # The name of the Pygments (syntax highlighting) style to use. @@ -108,7 +107,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 +118,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 5c111849..00000000 --- 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 ` - * :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 0cb4e27c..099769ea 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 e6b74a62..1bceb302 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 bccb54ac..06c07d1e 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 cd640563..25deadef 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 2b866d98..85d9cc87 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 537dce50..ae960d85 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 d76cebd0..07b3a27e 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 85fef76f..b96e502d 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 d2bd13e1..ee67102a 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 02277096..54c32e24 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 94712238..ed9f686b 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 fb4269d0..0e516b34 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 9c2a409b..b3033132 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 0be62294..00000000 --- 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; -}