docs

This documentation is built using Sphinx. It also uses some extensions for theming and REST API documentation support.

Start by installing the requirements:

pip install -r requirements.txt

Then you can generate the HTML version of the docs:

make html

The root of the documentation will be at _build/html/index.html

While editing the documentation, you can get a live preview using python-livepreview. Install the Python library:

pip install livereload

Then run the monitoring script in the background:

python autoreload.py &

If you install the browser extensions then everything should update every time any files are saved without any manual steps on your part.

Name		Name	Last commit message	Last commit date
parent directory ..
Makefile		Makefile
README.md		README.md
api.rst		api.rst
autoreload.py		autoreload.py
changelog.rst		changelog.rst
conf.py		conf.py
config.rst		config.rst
connect.rst		connect.rst
deployment.rst		deployment.rst
design.rst		design.rst
index.rst		index.rst
intro.rst		intro.rst
make.bat		make.bat
maven-plugin.rst		maven-plugin.rst
monitoring.rst		monitoring.rst
multi-dc-setup-kafka.graffle		multi-dc-setup-kafka.graffle
multi-dc-setup-kafka.png		multi-dc-setup-kafka.png
multi-dc-setup.graffle		multi-dc-setup.graffle
multi-dc-setup.png		multi-dc-setup.png
multidc.rst		multidc.rst
operations.rst		operations.rst
requirements.txt		requirements.txt
schema-deletion-guidelines.rst		schema-deletion-guidelines.rst
schema-registry-design-kafka.graffle		schema-registry-design-kafka.graffle
schema-registry-design-kafka.png		schema-registry-design-kafka.png
schema-registry-design.graffle		schema-registry-design.graffle
schema-registry-design.png		schema-registry-design.png
security.rst		security.rst
serializer-formatter.rst		serializer-formatter.rst

Provide feedback