Documentation: add tux logo

Message ID 20231029074207.297663-1-vegard.nossum@oracle.com
State New
Headers
Series Documentation: add tux logo |

Commit Message

Vegard Nossum Oct. 29, 2023, 7:42 a.m. UTC
  We already have the logo, let's use it.

Testing: make htmldocs

Cc: Miguel Ojeda <ojeda@kernel.org>
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
---
 Documentation/conf.py                  | 4 ++++
 Documentation/sphinx-static/custom.css | 6 ++++++
 2 files changed, 10 insertions(+)
  

Comments

Jonathan Corbet Nov. 17, 2023, 9:38 p.m. UTC | #1
Vegard Nossum <vegard.nossum@oracle.com> writes:

> We already have the logo, let's use it.
>
> Testing: make htmldocs
>
> Cc: Miguel Ojeda <ojeda@kernel.org>
> Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
> ---
>  Documentation/conf.py                  | 4 ++++
>  Documentation/sphinx-static/custom.css | 6 ++++++
>  2 files changed, 10 insertions(+)
>
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index d4fdf6a3875a..20bd74edcca9 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -357,6 +357,10 @@ html_sidebars = { '**': ['searchbox.html', 'kernel-toc.html', 'sourcelink.html']
>  if html_theme == 'alabaster':
>      html_sidebars['**'].insert(0, 'about.html')
>  
> +# The name of an image file (relative to this directory) to place at the top
> +# of the sidebar.
> +html_logo = 'images/logo.svg'
> +
>  # Output file base name for HTML help builder.
>  htmlhelp_basename = 'TheLinuxKerneldoc'
>  
> diff --git a/Documentation/sphinx-static/custom.css b/Documentation/sphinx-static/custom.css
> index 084a884f6fb7..56653f73d8f9 100644
> --- a/Documentation/sphinx-static/custom.css
> +++ b/Documentation/sphinx-static/custom.css
> @@ -20,6 +20,12 @@ div.document {
>      width: auto;
>  }
>  
> +/* Size the logo appropriately */
> +img.logo {
> +    width: 104px;
> +    margin-bottom: 20px;
> +}
> +
>  /*
>   * Parameters for the display of function prototypes and such included
>   * from C source files.

Applied, thanks.

jon
  

Patch

diff --git a/Documentation/conf.py b/Documentation/conf.py
index d4fdf6a3875a..20bd74edcca9 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -357,6 +357,10 @@  html_sidebars = { '**': ['searchbox.html', 'kernel-toc.html', 'sourcelink.html']
 if html_theme == 'alabaster':
     html_sidebars['**'].insert(0, 'about.html')
 
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = 'images/logo.svg'
+
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'TheLinuxKerneldoc'
 
diff --git a/Documentation/sphinx-static/custom.css b/Documentation/sphinx-static/custom.css
index 084a884f6fb7..56653f73d8f9 100644
--- a/Documentation/sphinx-static/custom.css
+++ b/Documentation/sphinx-static/custom.css
@@ -20,6 +20,12 @@  div.document {
     width: auto;
 }
 
+/* Size the logo appropriately */
+img.logo {
+    width: 104px;
+    margin-bottom: 20px;
+}
+
 /*
  * Parameters for the display of function prototypes and such included
  * from C source files.