[libcamera-devel,2/3] Documentation: Make the toctree more web-friendly

Message ID 20190110233829.9638-3-laurent.pinchart@ideasonboard.com
State Accepted
Commit f21090516def65a0e50348d2c45eea0875c05d57
Headers show
Series
  • Generate libcamera.org website from documentation
Related show

Commit Message

Laurent Pinchart Jan. 10, 2019, 11:38 p.m. UTC
The toctree is displayed in the navigation bar at the top of the page.
Add short names to the entries that replicate the names currently used
on libcamera.org.

Remove the link to the index and search pages, as the former is empty,
and the latter can be accessed directory from the navigation bar search
box.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/index.rst | 14 ++++----------
 1 file changed, 4 insertions(+), 10 deletions(-)

Comments

Kieran Bingham Jan. 11, 2019, 12:15 p.m. UTC | #1
On 10/01/2019 23:38, Laurent Pinchart wrote:
> The toctree is displayed in the navigation bar at the top of the page.
> Add short names to the entries that replicate the names currently used
> on libcamera.org.
> 
> Remove the link to the index and search pages, as the former is empty,
> and the latter can be accessed directory from the navigation bar search
> box.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> ---
>  Documentation/index.rst | 14 ++++----------
>  1 file changed, 4 insertions(+), 10 deletions(-)
> 
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 44176f230c0f..3e089e69729c 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -20,13 +20,7 @@ systems, including traditional Linux distributions, ChromeOS and Android.
>     :maxdepth: 2
>     :caption: Contents:
>  
> -   coding-style
> -   docs
> -   contributing
> -
> -
> -Indices and tables
> -==================
> -
> -* :ref:`genindex`
> -* :ref:`search`
> +   Home <self>
> +   Docs <docs>
> +   Coding Style <coding-style>
> +   Contribute <contributing>
>

Patch

diff --git a/Documentation/index.rst b/Documentation/index.rst
index 44176f230c0f..3e089e69729c 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -20,13 +20,7 @@  systems, including traditional Linux distributions, ChromeOS and Android.
    :maxdepth: 2
    :caption: Contents:
 
-   coding-style
-   docs
-   contributing
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`
+   Home <self>
+   Docs <docs>
+   Coding Style <coding-style>
+   Contribute <contributing>