You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
30
30
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.
32
32
33
33
## Generating the Documentation HTML
34
34
@@ -65,12 +65,12 @@ $ PRODUCTION=1 jekyll build
65
65
66
66
## API Docs (Scaladoc, Javadoc, Sphinx, roxygen2, MkDocs)
67
67
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.
69
69
70
70
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`
74
74
after [building Spark](https://github.com/apache/spark#building-spark) first.
75
75
76
76
When you run `jekyll build` in the `docs` directory, it will also copy over the scaladoc and javadoc for the various
0 commit comments