-
Notifications
You must be signed in to change notification settings - Fork 852
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5d4f020
commit 2d5a023
Showing
4 changed files
with
17 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,16 @@ | ||
pyspark Docset | ||
============== | ||
|
||
* Author: Rahul Iyer (https://twitter.com/rahuliyer95) - versions: 3.4.0 | ||
* Author: Rahul Iyer (https://twitter.com/rahuliyer95) - versions: 3.4.0, 3.5.2 | ||
* Author: Tomas Kunka (https://twitter.com/TomasKunka) - versions: 3.0.0, 2.4.0 | ||
* Author: Ronert Obst (https://twitter.com/ronert_obst) - versions: 2.1.0, 1.6.1, 1.5.1 | ||
* Instructions | ||
* Clone the Apache Spark repo | ||
* Modify `spark/python/docs/conf.py` and add `html_theme_options = {"nosidebar": "true"}` under `html_theme = 'nature'` | ||
* Clone the Apache Spark [repo](https://github.com/apache/spark) | ||
* Checkout the release branch for the version you are building the docs | ||
* Modify `spark/python/docs/conf.py` and add `html_theme_options = {"nosidebar": "true"}` | ||
* Export the following environment variables | ||
* `export GIT_HASH="$(git rev-parse HEAD | cut -c 1-12)"` | ||
* `export VERSION="<spark-version>"` e.g `VERSION="3.5.2"` | ||
* Run `make html` | ||
* Optionally `export SPHINXOPTS="-j auto --keep-going"` | ||
* Then run doc2dash | ||
* Then run [doc2dash](https://github.com/hynek/doc2dash) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.