Documentation: Add documentation-contents.rst

Add a new .rst file referencing the documentation contents. This file
is then included in each documentation page so that we can enhance
the Documentation pages on the libcamera website using it. As we do
not want the appearance of the libcamera in-tree Documentation to
change just yet, disable the new class using the sphinx theme's CSS.

To facilitate easier distinguishing between "normal" and
documentation pages on the website we want to add a "documentation"
class to the content of all such pages. Since this new file will be
included on each documentation page it is convenient to add the new
directive here - do so. As the website uses different CSS to
libcamera, move the contents on docs.rst a little so that the
directive at the end of the contents block applies correctly.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Documentation/camera-sensor-model.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. include:: documentation-contents.rst
+
 .. _camera-sensor-model:
 
 .. todo: Move to Doxygen-generated documentation

Documentation/code-of-conduct.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-4.0
 
+.. include:: documentation-contents.rst
+
 .. _code-of-conduct:
 
 Contributor Covenant Code of Conduct

Documentation/coding-style.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. include:: documentation-contents.rst
+
 .. _coding-style-guidelines:
 
 Coding Style Guidelines

Documentation/conf.py

@@ -61,7 +61,12 @@ language = 'en'
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = [
+    '_build',
+    'Thumbs.db',
+    '.DS_Store',
+    'documentation-contents.rst',
+]
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = None

Documentation/docs.rst

@@ -3,6 +3,8 @@
 .. contents::
    :local:
 
+.. include:: documentation-contents.rst
+
 *************
 Documentation
 *************

Documentation/documentation-contents.rst

@@ -0,0 +1,27 @@
+.. SPDX-License-Identifier: CC-BY-SA-4.0
+
+.. container:: documentation-nav
+
+   * :doc:`/api-html/index`
+   * :doc:`/camera-sensor-model`
+   * :doc:`/code-of-conduct`
+   * :doc:`/coding-style`
+   * :doc:`/environment_variables`
+   * :doc:`/guides/application-developer`
+   * :doc:`/guides/introduction`
+   * :doc:`/guides/ipa`
+   * :doc:`/guides/pipeline-handler`
+   * :doc:`/guides/tracing`
+   * :doc:`/lens_driver_requirements`
+   * :doc:`/python-bindings`
+   * :doc:`/sensor_driver_requirements`
+   * :doc:`/software-isp-benchmarking`
+
+..
+   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

Documentation/environment_variables.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. include:: documentation-contents.rst
+
 Environment variables
 =====================
 

Documentation/getting-started.rst

@@ -1,4 +1,5 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
+
 .. Getting started information is defined in the project README file.
 .. include:: ../README.rst
    :start-after: .. section-begin-getting-started

Documentation/guides/application-developer.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. include:: ../documentation-contents.rst
+
 Using libcamera in a C++ application
 ====================================
 

Documentation/guides/introduction.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. include:: ../documentation-contents.rst
+
 Developers guide to libcamera
 =============================
 

Documentation/guides/ipa.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. include:: ../documentation-contents.rst
+
 IPA Writer's Guide
 ==================
 

Documentation/guides/pipeline-handler.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. include:: ../documentation-contents.rst
+
 Pipeline Handler Writers Guide
 ==============================
 

Documentation/guides/tracing.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. include:: ../documentation-contents.rst
+
 Tracing Guide
 =============
 

Documentation/lens_driver_requirements.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. include:: documentation-contents.rst
+
 .. _lens-driver-requirements:
 
 Lens Driver Requirements

Documentation/meson.build

@@ -129,6 +129,7 @@ if sphinx.found()
         'conf.py',
         'contributing.rst',
         'docs.rst',
+        'documentation-contents.rst',
         'environment_variables.rst',
         'guides/application-developer.rst',
         'guides/introduction.rst',

Documentation/python-bindings.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. include:: documentation-contents.rst
+
 .. _python-bindings:
 
 Python Bindings for libcamera

Documentation/sensor_driver_requirements.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. include:: documentation-contents.rst
+
 .. _sensor-driver-requirements:
 
 Sensor Driver Requirements

Documentation/software-isp-benchmarking.rst

@@ -1,5 +1,7 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
+.. include:: documentation-contents.rst
+
 .. _software-isp-benchmarking:
 
 Software ISP benchmarking

Documentation/theme/static/css/theme.css

@@ -289,3 +289,7 @@ div#signature {
 	padding: 0px;
 	visibility: hidden;
 }
+
+.documentation-nav {
+	display: none;
+}