CrsiX / q-docs

Documentation for Q: https://github.com/myOmikron/Q

Documentation of Q

This is the documentation of Q. It uses mkdocs with the beautiful material theme.

Changes

In order to make changes and build the documentation following requirements are necessary:

• python
• python-pip

as well as the python modules:

python -m pip install -r requirements.txt

To build the documentation run:

mkdocs build

To spin up a self-refreshing development server:

mkdocs server -a bind_addr:port