README.md

Apache Cassandra documentation directory

This directory contains the documentation maintained in-tree for Apache Cassandra. This directory contains the following documents:

• The source of the official Cassandra documentation, in the source/ subdirectory. See below for more details on how to edit/build that documentation.
• The specification(s) for the supported versions of native transport protocol.
• Additional documentation on the SASI implementation (SASI.md). TODO: we should probably move the first half of that documentation to the general documentation, and the implementation explanation parts into the wiki.

Official documentation

The source for the official documentation for Apache Cassandra can be found in the source subdirectory. The documentation uses sphinx and is thus written in reStructuredText.

To build the HTML documentation, you will need to first install sphinx and the sphinx ReadTheDocs theme. When using Python 3.6 on Windows, use py -m pip install sphinx sphinx_rtd_theme, on unix use:

pip install sphinx sphinx_rtd_theme

The documentation can then be built from this directory by calling make html (or make.bat html on windows). Alternatively, the top-level ant gen-doc target can be used. When using Python 3.6 on Windows, use sphinx_build -b html source build.

To build the documentation with Docker Compose, run:

cd ./doc

# build the Docker image
docker-compose build build-docs

# build the documentation
docker-compose run build-docs

To regenerate the documentation from scratch, run:

# return to the root directory of the Cassandra project
cd ..

# remove all generated documentation files based on the source code
ant realclean