Kodular Documentation
Switch branches/tags
Clone or download

README.md

Website Travis (.com) Requires.io Codacy grade


Kodular Docs

The documentation source for Kodular lives is here.

The documentation rendered using MkDocs. This uses the Material theme for MkDocs.

Setting up

  1. Make sure you have Python and virtualenv installed on your system.

  2. Create a virtualenv

virtualenv kodular-docs-venv
  1. Activate your virtualenv:
  • On Linux : source kodular-docs-venv/bin/activate
  • On Windows : source kodular-docs-venv/Scripts/activate
  1. Install the dependencies using pip:
pip install -r requirements.txt
  1. You can preview the docs locally using the command:
mkdocs serve