Documentation

The documentation is generated with mkdocs. It generates a static website in plain HTML from the Markdown files present in the docs/ directory.

We also use the Cobra built-in documentation generator for dib commands.

Local Setup

Let's set up a local Python environment and run the documentation server with live-reload.

1. Create a virtual env:

   python -m venv venv
   source venv/bin/activate
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Generate docs of dib commands:

   make docs
   

4. Run the mkdocs server:

   mkdocs serve
   

5. Go to http://localhost:8000