Name		Name	Last commit message	Last commit date
parent directory ..
_static		_static
examples		examples
.gitignore		.gitignore
README.md		README.md
aerospike.rst		aerospike.rst
aerospike_helpers.batch.rst		aerospike_helpers.batch.rst
aerospike_helpers.cdt_ctx.rst		aerospike_helpers.cdt_ctx.rst
aerospike_helpers.expressions.rst		aerospike_helpers.expressions.rst
aerospike_helpers.metrics.rst		aerospike_helpers.metrics.rst
aerospike_helpers.operations.rst		aerospike_helpers.operations.rst
aerospike_helpers.rst		aerospike_helpers.rst
client.rst		client.rst
conf.py		conf.py
data_mapping.rst		data_mapping.rst
exception.rst		exception.rst
geojson.rst		geojson.rst
index.rst		index.rst
key_ordered_dict.rst		key_ordered_dict.rst
predicates.rst		predicates.rst
query.rst		query.rst
requirements.txt		requirements.txt
scan.rst		scan.rst
spelling_wordlist.txt		spelling_wordlist.txt
transaction.rst		transaction.rst

README.md

Sphinx Documentation

You can use Sphinx to generate documentation from the rst pages in this directory.

pip install -r requirements.txt

mkdir -p ./htmldir
sphinx-build -b html . htmldir

Then open the index.html page in a browser:

cd htmldir && open index.html

Spelling check:

sphinx-build -b spelling . spelling