StreamController Docs

Developer Guide

Using Make

1. Install mkdocs and dependencies: make install
2. Serve files locally make serve
3. Make changes, and preview them on http://localhost:8000
4. Once you are happy, commit, push and open pull request

Manual

1. Create python venv

   python -m venv .venv

2. Activate venv

   source .venv/bin/activate

3. Install requirements via pip

   pip install -r requirements.txt

4. Serve docs locally

   mkdocs serve

5. Make changes, and preview them on http://localhost:8000
6. Once you are happy, commit, push and open pull request

To publish a new version run:

run mike deploy --push --update-aliase VERSION latest