Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Kart docs

These docs are hosted at https://docs.kartproject.org/en/latest/

Docs are written using reStructuredText

Quick start for editors

To build the docs for local editing:

  1. Be in the docs directory
  2. 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
  1. 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.