The Internals of Spark SQL Online Book

The project contains the sources of The Internals of Spark SQL online book.

Tools

The project is based on or uses the following tools:

Apache Spark with Spark SQL
MkDocs which strives for being a fast, simple and downright gorgeous static site generator that's geared towards building project documentation
Material for MkDocs theme (with Insiders features)
Markdown
Visual Studio Code as a Markdown editor
Docker to run the Material for MkDocs (with extra plugins and extensions)

Previewing Book

Custom Docker Image

This project uses a custom Docker image (based on the Insiders image) since the official Docker image includes just a few plugins only.

Build the custom Docker image using the following command:

docker build \
  -t jaceklaskowski/mkdocs-material-insiders \
  -t jaceklaskowski/mkdocs-material-insiders:6.2.3-insiders-1.15.0 \
  .

Building Book

Run the following command to build the book.

docker run \
  -it \
  -p 8000:8000 \
  -v ${PWD}:/docs \
  jaceklaskowski/mkdocs-material-insiders \
  build --clean

TIP: Consult the Material for MkDocs documentation to get started.

Live Editing

Start mkdocs serve (with --dirtyreload for faster reloads) as follows:

docker run \
  -it \
  -p 8000:8000 \
  -v ${PWD}:/docs \
  jaceklaskowski/mkdocs-material-insiders \
  serve --dirtyreload --verbose --dev-addr 0.0.0.0:8000

You should start the above command in the project root (the folder with mkdocs.yml).

No Sphinx?! Why?

Read Giving up on Read the Docs, reStructuredText and Sphinx.