Notice

Moved to a monorepo structure.

Contributor Documentation

Fuse documentation and website is powered by mkdocs. For full documentation visit mkdocs.org.

Python is required to build the website. Mkdocs also provides a server with auto hot reload for development.

Setting up the development environment

If you don't have already have a virtual env, it would be recommended to create one:

python3 -m venv venv

Activate the environment:

source venv/bin/activate

And install the dependencies:

pip3 install -r requirements.txt

To deactivate/exit the virtual environment, run:

deactivate

Building the documentation

This section assumes you're already in a python virtual env.

Building can be done by running:

mkdocs build

However, if you want to actually test and see your changes, serving might be better:

mkdocs serve

This will run a local webserver.

Common Mkdocs Commands

• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.