This repository contains all the user content of KoboToolbox's official documentation, available at https://support.kobotoolbox.org/.
To build and test this documentation locally follow these steps:
Prerequisites:
git clone https://github.com/kobotoolbox/docs.git
cd docs
npm install && npm start
python -m venv koboenv
source koboenv/bin/activate
pip install -r requirements.txt
make html
open _build/html/index.html
Note: if you have Python 3, you might need to use python3
command instead of python
(and pip3
instead of pip
).
Each commit to master
is automatically built into production.
When you already did everything from "Local installation" succesfully and just need to come back and work a bit more on the project, please use dev.sh
script from the root of the project.
We build our theme atop Read The Docs theme by replacing their CSS
with our own (which is a heavily modified copy of theirs).
To develop the theme:
npm install
npm run dev
npm start
Useful links:
.html
files