The project contains the sources of The Internals of Delta Lake online book in reStructuredText Primer.

The aim of the project are to learn the following:

• Delta Lake as it comes from my gurus from the Spark SQL / Structured Streaming crew at Databricks (Michael, TD, Burak, zsxwing, and many others)

• Read the Docs for online documentation with support for GitHub and multiple versions

• reStructuredText - the default plaintext markup language used by Sphinx and the preferred format for technical documentation at Read the Docs

I'm on macOS Catalina and followed Installing Sphinx on macOS with brew packager.

// Installs into /usr/local/opt/sphinx-doc/bin
$ brew install sphinx-doc

$ type sphinx-quickstart
sphinx-quickstart not found

$ /usr/local/opt/sphinx-doc/bin/sphinx-quickstart --version
sphinx-quickstart 2.2.1

$ make html

$ open _build/html/index.html

I use Atom Editor with language-restructuredtext plugin for editing rst files.

I wish I could use Docker with the python official image as the writing environment.

$ docker pull python

$ docker run \
   -it \
   --rm \
   --name sphinx \
   -v "$PWD":/docs \
   -w /docs \
   -e USER_ID=$UID \
   python \
   /bin/bash