README.md

Code with Style

An opinionated guide on how we like our code and how we like to write it.

The HTML version can be found publicly on gitlab.com pages.

This work is licensed under a Creative Commons Attribution 4.0 Generic License.

Note to Grey Rook employees

Please keep in mind that the internal git repository is regularly synced with the public ones at gitlab.com and github.com. Do not include internal information in the guide.

Building HTML

The docs are generated with mkdocs. Install the dependencies:

poetry install

Run a local development server with watch and autoreload:

poetry run mkdocs serve

Build docs as html:

poetry run mkdocs build