Skip to content

Commit 86b3b28

Browse files
committed
%s/SPARK_HOME/$SPARK_HOME/gc
1 parent a0bba18 commit 86b3b28

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ $ sudo Rscript -e 'devtools::install_version("roxygen2", version = "5.0.1", repo
2828

2929
Note: If you are on a system with both Ruby 1.9 and Ruby 2.0 you may need to replace gem with gem2.0.
3030

31-
Note: Other versions of roxygen2 might work in SparkR documentation generation but `RoxygenNote` field in `SPARK_HOME/R/pkg/DESCRIPTION` is 5.0.1, which is updated if the version is mismatched.
31+
Note: Other versions of roxygen2 might work in SparkR documentation generation but `RoxygenNote` field in `$SPARK_HOME/R/pkg/DESCRIPTION` is 5.0.1, which is updated if the version is mismatched.
3232

3333
## Generating the Documentation HTML
3434

@@ -65,12 +65,12 @@ $ PRODUCTION=1 jekyll build
6565

6666
## API Docs (Scaladoc, Javadoc, Sphinx, roxygen2, MkDocs)
6767

68-
You can build just the Spark scaladoc and javadoc by running `build/sbt unidoc` from the `SPARK_HOME` directory.
68+
You can build just the Spark scaladoc and javadoc by running `build/sbt unidoc` from the `$SPARK_HOME` directory.
6969

7070
Similarly, you can build just the PySpark docs by running `make html` from the
71-
`SPARK_HOME/python/docs` directory. Documentation is only generated for classes that are listed as
72-
public in `__init__.py`. The SparkR docs can be built by running `SPARK_HOME/R/create-docs.sh`, and
73-
the SQL docs can be built by running `SPARK_HOME/sql/create-docs.sh`
71+
`$SPARK_HOME/python/docs` directory. Documentation is only generated for classes that are listed as
72+
public in `__init__.py`. The SparkR docs can be built by running `$SPARK_HOME/R/create-docs.sh`, and
73+
the SQL docs can be built by running `$SPARK_HOME/sql/create-docs.sh`
7474
after [building Spark](https://github.com/apache/spark#building-spark) first.
7575

7676
When you run `jekyll build` in the `docs` directory, it will also copy over the scaladoc and javadoc for the various

0 commit comments

Comments
 (0)