EKEEL Documentation

Welcome to the EKEEL documentation repository. This repository uses MkDocs to generate and host the documentation for the EKEEL project.

Overview

EKEEL (Empowering Knowledge Extraction to Empower Learners) is a research project funded by the Italian Ministry of University and Research (MUR) under the PRIN 2022 PNRR programme, a nationally managed programme supported through the European Union – Next Generation EU.

The project aims to develop tools and services for knowledge extraction and its application to video augmentation. This repository hosts the official documentation of the EKEEL project, including setup guides, deployment instructions, and technical references to the project components and codebase.

The documentation refreshes every Monday at 4 AM and updates the website content.

Repositories

The EKEEL project consists of the following repositories:

• EKEEL-video-annotation: This repository contains the code for the EKEEL Annotator - Responsible Unit: University of Genoa (UniGe).
• EKEEL-kg-extraction: This repository contains the code for the EKEEL Extractor - Responsible Unit: National Research Council (CNR).
• EKEEL-video-augmentation: This repository contains the code for the EKEEL Augmentator - Responsible Unit: University of Genoa (UniGe).
• EKEEL-learning-analytics: This repository contains the code for the EKEEL Learning Analytics: University of Genoa (UniGe).

Documentation

The documentation is organized using MkDocs with the Material theme. The documentation includes:

• Quickstart Guides: Instructions to quickly set up and deploy the services.
• Codebase Documentation: Detailed documentation of the codebase, generated using mkdocstrings.
• Deployment Guides: Step-by-step guides to deploy the services locally and remotely.

Getting Started

The documentation deployment has been tested on Ubuntu 24 but should work with small adaptations on WSL

To build and serve the documentation locally, follow these steps:

1. Clone this repository:

   git clone https://github.com/ekeel-project/ekeel.git
   cd ekeel

2. Clone the project repositories:

   mkdir -p apps
   git clone https://github.com/ekeel-project/EKEEL_annotator.git apps/EKEEL_annotator
   git clone https://github.com/ekeel-project/EKEEL_extractor.git apps/EKEEL_extractor
   git clone https://github.com/ekeel-project/EKEEL_augmentator.git apps/EKEEL_augmentator
   git clone https://github.com/ekeel-project/EKEEL_learning_analytics.git apps/EKEEL_learning_analytics

3. Install the required dependencies:

   pip install -r mkdocs/requirements.txt

4. Build and serve the documentation:

   mkdocs serve

5. Open your browser and navigate to http://127.0.0.1:8000/docs/ to view the documentation.

WARNING

The branch gh-pages is used for the deployment of the website. Be careful not to overwrite this branch.

Contributing

We welcome contributions to improve the documentation. If you find any issues or have suggestions, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.