[spark] branch master updated: [SPARK-44729][PYTHON][DOCS] Add canonical links to the PySpark docs page

[ru...@apache.org]

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

ruifengz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/spark.git


The following commit(s) were added to refs/heads/master by this push:
     new c88ced88af9 [SPARK-44729][PYTHON][DOCS] Add canonical links to the PySpark docs page
c88ced88af9 is described below

commit c88ced88af9a502a9e5352e31bb2963506ecb172
Author: panbingkun <pb...@gmail.com>
AuthorDate: Fri Aug 18 20:36:48 2023 +0800

    [SPARK-44729][PYTHON][DOCS] Add canonical links to the PySpark docs page
    
    ### What changes were proposed in this pull request?
    The pr aims to add canonical links to the PySpark docs page.
    
    ### Why are the changes needed?
    We should add the canonical link to the PySpark docs page https://spark.apache.org/docs/latest/api/python/index.html so that the search engine can return the latest PySpark docs.
    
    ### Does this PR introduce _any_ user-facing change?
    No.
    
    ### How was this patch tested?
    Manual testing.
    ```
    cd python/docs
    make html
    ```
    
    Closes #42425 from panbingkun/SPARK-44729.
    
    Authored-by: panbingkun <pb...@gmail.com>
    Signed-off-by: Ruifeng Zheng <ru...@apache.org>
---
 python/docs/source/conf.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/python/docs/source/conf.py b/python/docs/source/conf.py
index 8203a802053..38c331048e7 100644
--- a/python/docs/source/conf.py
+++ b/python/docs/source/conf.py
@@ -259,6 +259,8 @@ html_use_index = False
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'pysparkdoc'
 
+# The base URL which points to the root of the HTML documentation.
+html_baseurl = 'https://spark.apache.org/docs/latest/api/python'
 
 # -- Options for LaTeX output ---------------------------------------------
 


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@spark.apache.org
For additional commands, e-mail: commits-help@spark.apache.org