Skip to content

rorm-orm/docs

Repository files navigation

Documentation of RORM

This is the documentation of RORM. 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 serve -a bind_addr:port