This repo collects the collaborative work on Cube AI documentation.
Documentation is auto-generated from Markdown files in this repo.
MkDocs is used to serve the docs locally with different theming.
Doc repo can be fetched from GitHub:
git clone https://github.com/ultravioletrs/cube-docs.git
Python is required to run MkDocs.
-
Create a virtual environment:
python -m venv venv
-
Activate the virtual environment:
source venv/bin/activate
-
Install MkDocs
pip install mkdocs
-
Additionally, install Material theme:
pip install mkdocs-material
Use MkDocs to serve documentation:
mkdocs serve
Then just point the browser to http://127.0.0.1:8000.