You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by ra...@apache.org on 2023/04/18 13:39:27 UTC

[arrow] branch main updated: GH-35192: [Docs] Switch from `logo` to `logo_url` to support sphinx >= 6 (#35194)

This is an automated email from the ASF dual-hosted git repository.

raulcd pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git


The following commit(s) were added to refs/heads/main by this push:
     new 00072f9f95 GH-35192: [Docs] Switch from `logo` to `logo_url` to support sphinx >= 6 (#35194)
00072f9f95 is described below

commit 00072f9f95b61ed58f5ffcb52fb8a1e0956dfa91
Author: Weston Pace <we...@gmail.com>
AuthorDate: Tue Apr 18 06:39:11 2023 -0700

    GH-35192: [Docs] Switch from `logo` to `logo_url` to support sphinx >= 6 (#35194)
    
    ### Rationale for this change
    
    Sphinx dropped support for the `logo` property in release 6.  See https://github.com/sphinx-doc/sphinx/issues/11062  Instead we are supposed to use `logo_url` which has been available since release 4.
    
    ### What changes are included in this PR?
    
    Change from `logo` to `logo_url`
    
    ### Are these changes tested?
    
    There was a CI test that was failing so yes.
    
    ### Are there any user-facing changes?
    
    No.  We already required `sphinx >= 4` and since `logo_url` is available in 4 we should not need to update the minimum sphinx version.
    * Closes: #35192
    
    Authored-by: Weston Pace <we...@gmail.com>
    Signed-off-by: Raúl Cumplido <ra...@gmail.com>
---
 docs/source/_templates/docs-sidebar.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/source/_templates/docs-sidebar.html b/docs/source/_templates/docs-sidebar.html
index fde4435df3..64aee59ed4 100644
--- a/docs/source/_templates/docs-sidebar.html
+++ b/docs/source/_templates/docs-sidebar.html
@@ -1,6 +1,6 @@
 
 <a class="navbar-brand" href="{{ pathto(master_doc) }}">
-  <img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="logo">
+  <img src="{{ pathto('_static/' + logo_url, 1) }}" class="logo" alt="logo">
 </a>
 
 <div id="version-search-wrapper">