Project and Requirement Documentation for the European Campus Card Pilot Project by the EUGLOH Workpackage - Campus Life

The generated documentation is publical availiable under: https://ecc-pilot.github.io/documentation/

How to participate / contribute to the Project and Documentation

Get in touch

Please contact: [email protected]

Writing and Building the Documentation

This repository uses Sphinx and MyST-parser for generating the documentation.

Setup / Installation for development / contribution

Linux or Mac

• Create a Python 3 Virtual Environment:

python -m venv venv
# or 
python3 -m venv venv

• Activate the Virtual Environment:

source venv/bin/activate

• Install the requirements for local development / generating the documentation:

python -m pip install -U -r requirements-develop.txt -c constraints.txt

Windows

• Create a Python 3 Virtual Environment:

GitHub WebIDE / VS Code Online