These docs are hosted at https://docs.kartproject.org/en/latest/
Docs are written using reStructuredText
To build the docs for local editing:
- Be in the
docs
directory - If you don't already have a kart virtualenv for local development, create one for building docs:
python3 -m venv venv
source venv/bin/activate
pip install -r ../requirements/docs.txt
- Build the docs using sphinx:
make html
This will place HTML files in _build/html/
- visit that directory in your browser to see the result.
Edit the docs at will, preview changes in your browser, and submit a PR with your changes when you're done.