Github user HyukjinKwon commented on a diff in the pull request:
https://github.com/apache/spark/pull/19019#discussion_r134479961
--- Diff: docs/README.md ---
@@ -32,42 +35,50 @@ the source code and be captured by revision control
(currently git). This way th
includes the version of the documentation that is relevant regardless of
which version or release
you have checked out or downloaded.
-In this directory you will find textfiles formatted using Markdown, with
an ".md" suffix. You can
-read those text files directly if you want. Start with index.md.
+In this directory you will find text files formatted using Markdown, with
an ".md" suffix. You can
+read those text files directly if you want. Start with `index.md`.
Execute `jekyll build` from the `docs/` directory to compile the site.
Compiling the site with
-Jekyll will create a directory called `_site` containing index.html as
well as the rest of the
+Jekyll will create a directory called `_site` containing `index.html` as
well as the rest of the
compiled files.
- $ cd docs
- $ jekyll build
+```sh
+$ cd docs
+$ jekyll build
+```
You can modify the default Jekyll build as follows:
+
```sh
- # Skip generating API docs (which takes a while)
- $ SKIP_API=1 jekyll build
-
- # Serve content locally on port 4000
- $ jekyll serve --watch
-
- # Build the site with extra features used on the live page
- $ PRODUCTION=1 jekyll build
+# Skip generating API docs (which takes a while)
+$ SKIP_API=1 jekyll build
+
+# Serve content locally on port 4000
+$ jekyll serve --watch
+
+# Build the site with extra features used on the live page
+$ PRODUCTION=1 jekyll build
```
-## API Docs (Scaladoc, Sphinx, roxygen2)
+## API Docs (Scaladoc, Javadoc, Sphinx, roxygen2, MkDocs)
-You can build just the Spark scaladoc by running `build/sbt unidoc` from
the SPARK_PROJECT_ROOT directory.
--- End diff --
I think we don't use the term `SPARK_PROJECT_ROOT` anywhere except for
here. I rather chose the close term `SPARK_HOME`.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
