SPARK-3579 Jekyll doc generation is different across environments.
This patch makes some small changes to fix this problem: 1. We document specific versions of Jekyll/Kramdown to use that match those used when building the upstream docs. 2. We add a configuration for a property that for some reason varies across packages of Jekyll/Kramdown even with the same version. Author: Patrick Wendell <pwendell@gmail.com> Closes #2443 from pwendell/jekyll and squashes the following commits: 54ee2ab [Patrick Wendell] SPARK-3579 Jekyll doc generation is different across environments.
This commit is contained in:
parent
3447d10090
commit
3ad4176cf9
|
@ -20,12 +20,16 @@ In this directory you will find textfiles formatted using Markdown, with an ".md
|
|||
read those text files directly if you want. Start with index.md.
|
||||
|
||||
The markdown code can be compiled to HTML using the [Jekyll tool](http://jekyllrb.com).
|
||||
To use the `jekyll` command, you will need to have Jekyll installed.
|
||||
The easiest way to do this is via a Ruby Gem, see the
|
||||
[jekyll installation instructions](http://jekyllrb.com/docs/installation).
|
||||
If not already installed, you need to install `kramdown` and `jekyll-redirect-from` Gems
|
||||
with `sudo gem install kramdown jekyll-redirect-from`.
|
||||
Execute `jekyll build` from the `docs/` directory. Compiling the site with Jekyll will create a directory
|
||||
`Jekyll` and a few dependencies must be installed for this to work. We recommend
|
||||
installing via the Ruby Gem dependency manager. Since the exact HTML output
|
||||
varies between versions of Jekyll and its dependencies, we list specific versions here
|
||||
in some cases:
|
||||
|
||||
$ sudo gem install jekyll -v 1.4.3
|
||||
$ sudo gem uninstall kramdown -v 1.4.1
|
||||
$ sudo gem install jekyll-redirect-from
|
||||
|
||||
Execute `jekyll` from the `docs/` directory. Compiling the site with Jekyll will create a directory
|
||||
called `_site` containing index.html as well as the rest of the compiled files.
|
||||
|
||||
You can modify the default Jekyll build as follows:
|
||||
|
|
|
@ -3,6 +3,11 @@ markdown: kramdown
|
|||
gems:
|
||||
- jekyll-redirect-from
|
||||
|
||||
# For some reason kramdown seems to behave differently on different
|
||||
# OS/packages wrt encoding. So we hard code this config.
|
||||
kramdown:
|
||||
entity_output: numeric
|
||||
|
||||
# These allow the documentation to be updated with nerw releases
|
||||
# of Spark, Scala, and Mesos.
|
||||
SPARK_VERSION: 1.0.0-SNAPSHOT
|
||||
|
|
Loading…
Reference in a new issue