[2/7] Documentation: Alphabetise the Documentation toctree
diff mbox series

Message ID 20240809145304.537551-3-dan.scally@ideasonboard.com
State Superseded
Headers show
Series
  • Documentation improvements
Related show

Commit Message

Dan Scally Aug. 9, 2024, 2:52 p.m. UTC
With the exception of the initial group of four links, alphabetise
the pages in the Documentation toctree so adding new ones can be
done in a defined order.

Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>
---
 Documentation/index.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

Comments

Laurent Pinchart Aug. 14, 2024, 10:27 p.m. UTC | #1
Hi Dan,

Thank you for the patch.

On Fri, Aug 09, 2024 at 03:52:59PM +0100, Daniel Scally wrote:
> With the exception of the initial group of four links, alphabetise
> the pages in the Documentation toctree so adding new ones can be
> done in a defined order.
>
> Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>

I would like to sort the documents by category, to provide a better
experience when reading through the documentation. This can be done
later though, so if you think alphabetical order is better for now, I'm
OK with it.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  Documentation/index.rst | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 5442ae75..52ddc494 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -14,14 +14,14 @@
>     Contribute <contributing>
>     Getting Started <getting-started>
>  
> -   Developer Guide <guides/introduction>
>     Application Writer's Guide <guides/application-developer>
> -   Pipeline Handler Writer's Guide <guides/pipeline-handler>
> -   IPA Writer's guide <guides/ipa>
> -   Tracing guide <guides/tracing>
> +   Camera Sensor Model <camera-sensor-model>
> +   Developer Guide <guides/introduction>
>     Environment variables <environment_variables>
> -   Sensor driver requirements <sensor_driver_requirements>
> +   IPA Writer's guide <guides/ipa>
>     Lens driver requirements <lens_driver_requirements>
> +   Pipeline Handler Writer's Guide <guides/pipeline-handler>
>     Python Bindings <python-bindings>
> -   Camera Sensor Model <camera-sensor-model>
> +   Sensor driver requirements <sensor_driver_requirements>
>     SoftwareISP Benchmarking <software-isp-benchmarking>
> +   Tracing guide <guides/tracing>

Patch
diff mbox series

diff --git a/Documentation/index.rst b/Documentation/index.rst
index 5442ae75..52ddc494 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -14,14 +14,14 @@ 
    Contribute <contributing>
    Getting Started <getting-started>
 
-   Developer Guide <guides/introduction>
    Application Writer's Guide <guides/application-developer>
-   Pipeline Handler Writer's Guide <guides/pipeline-handler>
-   IPA Writer's guide <guides/ipa>
-   Tracing guide <guides/tracing>
+   Camera Sensor Model <camera-sensor-model>
+   Developer Guide <guides/introduction>
    Environment variables <environment_variables>
-   Sensor driver requirements <sensor_driver_requirements>
+   IPA Writer's guide <guides/ipa>
    Lens driver requirements <lens_driver_requirements>
+   Pipeline Handler Writer's Guide <guides/pipeline-handler>
    Python Bindings <python-bindings>
-   Camera Sensor Model <camera-sensor-model>
+   Sensor driver requirements <sensor_driver_requirements>
    SoftwareISP Benchmarking <software-isp-benchmarking>
+   Tracing guide <guides/tracing>