[SPARK-27557] Add copybutton to spark Python API docs for easier copying of code-blocks

• Type: Documentation
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 2.4.2
• Fix Version/s: 3.0.0
• Component/s: Documentation, PySpark
• Labels: Documentation PySpark
• Assignee: Sangram G
• Reporter: Sangram G
• Created: 24/Apr/19 15:10
• Updated: 12/Dec/22 18:11
• Resolved: 01/May/19 16:27

Description

Add a non-intrusive button for python API documentation, which will remove ">>>" prompts and outputs of code - for easier copying of code.

For example: The below code-snippet in the document is difficult to copy due to ">>>" prompts

>>> l = [('Alice', 1)]
>>> spark.createDataFrame(l).collect()
[Row(_1='Alice', _2=1)]

Becomes this - After the copybutton in the corner of of code-block is pressed - which is easier to copy

l = [('Alice', 1)]
spark.createDataFrame(l).collect()

Sample Screenshot for reference: https://screenshots.firefox.com/ZfBXZrpINKdt9QZg/www269.lunapic.com

This can be easily done only by adding a copybutton.js script in python/docs/_static folder and calling it at setup time from python/docs/conf.py.

Issue Links

• links to: GitHub Pull Request #24456