History

Tyler Hobbs 7ea727cded Ninja: actually commit images for IDE section of docs Follow up to CASSANDRA-12449		2016-08-30 11:02:09 -05:00
..
cql3	Add support for GROUP BY to SELECT statement	2016-08-04 17:09:38 +02:00
source	Ninja: actually commit images for IDE section of docs	2016-08-30 11:02:09 -05:00
Makefile	Add theme for inclusion of the documentation on the website	2016-08-01 17:19:50 +02:00
README.md	Add initial in-tree documentation (very incomplete so far)	2016-06-14 18:16:42 +02:00
SASI.md	SASI index options validation	2016-02-10 11:41:03 -08:00
convert_yaml_to_rst.py	Initial FAQ section	2016-06-28 17:09:48 +02:00
make.bat	Add initial in-tree documentation (very incomplete so far)	2016-06-14 18:16:42 +02:00
native_protocol_v3.spec	Correct section number of opcode section in protocol spec	2016-06-03 19:29:19 +01:00
native_protocol_v4.spec	Merge branch 'cassandra-2.2' into cassandra-3.0	2016-08-17 18:07:36 -05:00
native_protocol_v5.spec	Add error code map to read/write failure responses	2016-08-19 16:04:39 -05:00

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](the https://pypi.python.org/pypi/sphinx_rtd_theme), which on unix you can do with:

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.