This repository provides the official documentation and specifications for SUNRISE, the Scalable Unified RESTful Infrastructure for System Evaluation.

🔗 Hosted on GitHub Pages

The documentation is built using MkDocs.

• The content is written in Markdown files, which are stored in the docs/ directory.
• The structure and settings are configured in the mkdocs.yml file.

For editing and local preview, MkDocs can be installed as a Python pip package. All commands must be called from the root of this repository.

Installation:

# (Optional) Create and activate a Python Virtual Environment
python -m venv venv
source venv/bin/activate

# Install the required Python packages
pip install -r requirements.txt

Build and Preview:

# Start a local web-server to preview the docs
mkdocs serve

# Or: Just generate the static HTML files into the 'site/' directory
mkdocs build

The included deployment workflow automates the process of building and publishing the documentation as a web page. The workflow automatically generates html from the master branch and pushes it to the branch gh-pages which is used to host the web-page with GitHub Pages.

Questions and requests can be raised via GitHub issues. Please see the contribution guide for further information on how to get involved.

SUNRISE Documentation © 2025 by Robert Bosch GmbH is licensed under CC BY-SA 4.0.
To view a copy of this license, visit https://creativecommons.org/licenses/by-sa/4.0/

Cite this work as defined in the included citation file.

This work was initiated as a research project by Robert Bosch GmbH.