This is an automated email from the ASF dual-hosted git repository.
dongjoon 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 8060e7e73170 [SPARK-46199][PYTHON][DOCS] Add PyPi link icon to PySpark
doc header
8060e7e73170 is described below
commit 8060e7e73170c0122acb2a005f3c54487e226208
Author: panbingkun <pbk1...@gmail.com>
AuthorDate: Fri Dec 1 12:29:29 2023 -0800
[SPARK-46199][PYTHON][DOCS] Add PyPi link icon to PySpark doc header
### What changes were proposed in this pull request?
This PR proposes to introduce a `PyPi link icon` in the header of the
PySpark documentation, similar to what is currently implemented in the
`pydata-sphinx-theme` docs.
https://pydata-sphinx-theme.readthedocs.io/en/v0.13.3/user_guide/styling.html#
<img width="1417" alt="image"
src="https://github.com/apache/spark/assets/15246973/4bb66f51-96e7-45d5-890b-03a4700f1ec7";>
### Why are the changes needed?
This change aligns with the practices of other open-source projects like
`pydata-sphinx-theme`, facilitating community engagement and collaboration.
### Does this PR introduce _any_ user-facing change?
No API changes, but a `PyPi link icon` will be added to the top right
corner of the PySpark docs header. This icon will be linked to the `PySpark
PyPi` as below:
<img width="1419" alt="image"
src="https://github.com/apache/spark/assets/15246973/4c5a70a0-cb30-4615-827d-97610a71d5e4";>
### How was this patch tested?
Manually test.
### Was this patch authored or co-authored using generative AI tooling?
No.
Closes #44106 from panbingkun/SPARK-46199.
Authored-by: panbingkun <pbk1...@gmail.com>
Signed-off-by: Dongjoon Hyun <dh...@apple.com>
---
python/docs/source/conf.py | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/python/docs/source/conf.py b/python/docs/source/conf.py
index 0ac06f802c95..640155cee5a3 100644
--- a/python/docs/source/conf.py
+++ b/python/docs/source/conf.py
@@ -204,7 +204,18 @@ html_theme_options = {
"image_light": "_static/spark-logo-light.png",
"image_dark": "_static/spark-logo-dark.png",
},
- "github_url": "https://github.com/apache/spark";,
+ "icon_links": [
+ {
+ "name": "GitHub",
+ "url": "https://github.com/apache/spark";,
+ "icon": "fa-brands fa-github",
+ },
+ {
+ "name": "PyPI",
+ "url": "https://pypi.org/project/pyspark";,
+ "icon": "fa-solid fa-box",
+ },
+ ]
}
# Add any paths that contain custom themes here, relative to this directory.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org
For additional commands, e-mail: commits-h...@spark.apache.org
