NekoCWD/libcamera
NekoCWD/libcamera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 7 Wiki Activity Actions

Documentation: Rework index.rst

Browse source 
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. As
we're no longer including the content from README.rst the labels that
enabled that can be dropped.

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 currently hides the toctree from
the generated body in html, as it's already displayed on every page via
the theme's CSS. This change reorders the page such that the CSS that
hides the toctree no longer works - update the CSS to retain the
current behaviour.

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>
This commit is contained in:
Daniel Scally 2024-08-20 14:07:38 +01:00 • committed by Laurent Pinchart
parent 860a3e3031
commit 69d11d29a2
3 changed files with 7 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Documentation/index.rst
View file

@ -1,16 +1,12 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0 .. SPDX-License-Identifier: CC-BY-SA-4.0
.. Front page matter is defined in the project README file. .. include:: introduction.rst
.. include:: ../README.rst
:start-after: .. section-begin-libcamera
:end-before: .. section-end-libcamera
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
:caption: Contents: :caption: Contents:
Home <self> Home <self>
Introduction <introduction>
Contribute <contributing> Contribute <contributing>
Getting Started <getting-started> Getting Started <getting-started>
@ -26,3 +22,8 @@
Sensor driver requirements <sensor_driver_requirements> Sensor driver requirements <sensor_driver_requirements>
SoftwareISP Benchmarking <software-isp-benchmarking> SoftwareISP Benchmarking <software-isp-benchmarking>
Tracing guide <guides/tracing> Tracing guide <guides/tracing>
.. toctree::
:hidden:
introduction

2
Documentation/theme/static/css/theme.css
View file

@ -283,7 +283,7 @@ div#signature {
font-size: 12px; font-size: 12px;
} }
#libcamera div.toctree-wrapper { #licensing div.toctree-wrapper {
height: 0px; height: 0px;
margin: 0px; margin: 0px;
padding: 0px; padding: 0px;

3
README.rst
View file

@ -1,7 +1,5 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0 .. SPDX-License-Identifier: CC-BY-SA-4.0
.. section-begin-libcamera
=========== ===========
libcamera libcamera
=========== ===========
@ -22,7 +20,6 @@ open-source-friendly while still protecting vendor core IP. libcamera was born
out of that collaboration and will offer modern camera support to Linux-based out of that collaboration and will offer modern camera support to Linux-based
systems, including traditional Linux distributions, ChromeOS and Android. systems, including traditional Linux distributions, ChromeOS and Android.
.. section-end-libcamera
.. section-begin-getting-started .. section-begin-getting-started
Getting Started Getting Started