base-jkes-search/jkes-services/jkes-delete-connector/docs/README.md

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.