https://github.com/rorm-orm/docs
The documentation for rorm and dorm
https://github.com/rorm-orm/docs
Last synced: 10 months ago
JSON representation
The documentation for rorm and dorm
- Host: GitHub
- URL: https://github.com/rorm-orm/docs
- Owner: rorm-orm
- License: mit
- Created: 2022-11-22T00:14:21.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T20:39:28.000Z (over 1 year ago)
- Last Synced: 2025-01-11T03:40:30.501Z (12 months ago)
- Size: 70.3 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Documentation of RORM
This is the documentation of [RORM](https://github.com/myOmikron/dorm). 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:
```bash
python -m pip install -r requirements.txt
```
To build the documentation run:
```bash
mkdocs build
```
To spin up a self-refreshing development server:
```bash
mkdocs serve -a bind_addr:port
```