[PATCH 7/7] Documentation: Rework index.rst

Daniel Scally dan.scally at ideasonboard.com
Fri Aug 9 16:53:04 CEST 2024


index.rst is the page that becomes index.html, but currently just has
some blurb. Although this page will only be seen if viewing the docs
as built from the libcamera tree it'd be better if it were more of an
introductory page. Include the content of docs.rst to improve it.

With this change whether viewing the documentation as built in the
libcamera tree or on the Docs page of the website, the landing content
will be the same.

The CSS for the documentation's theme is updated so that section ID
references still fix the right problem.

Signed-off-by: Daniel Scally <dan.scally at ideasonboard.com>
---
 Documentation/index.rst                  | 10 ++++++----
 Documentation/theme/static/css/theme.css |  2 +-
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/Documentation/index.rst b/Documentation/index.rst
index 6d7d2ca3..0fe10706 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -1,16 +1,13 @@
 .. SPDX-License-Identifier: CC-BY-SA-4.0
 
 .. Front page matter is defined in the project README file.
-.. include:: ../README.rst
-   :start-after: .. section-begin-libcamera
-   :end-before: .. section-end-libcamera
+.. include:: docs.rst
 
 .. toctree::
    :maxdepth: 1
    :caption: Contents:
 
    Home <self>
-   Docs <docs>
    Contribute <contributing>
    Getting Started <getting-started>
 
@@ -26,3 +23,8 @@
    Sensor driver requirements <sensor_driver_requirements>
    SoftwareISP Benchmarking <software-isp-benchmarking>
    Tracing guide <guides/tracing>
+
+.. toctree::
+   :hidden:
+
+   docs
\ No newline at end of file
diff --git a/Documentation/theme/static/css/theme.css b/Documentation/theme/static/css/theme.css
index 2b1ed095..a6d43195 100644
--- a/Documentation/theme/static/css/theme.css
+++ b/Documentation/theme/static/css/theme.css
@@ -283,7 +283,7 @@ div#signature {
 	font-size: 12px;
 }
 
-#libcamera div.toctree-wrapper {
+#licensing div.toctree-wrapper {
 	height: 0px;
 	margin: 0px;
 	padding: 0px;
-- 
2.34.1



More information about the libcamera-devel mailing list