This is the repository of the official documentation of eduTAP.
Its HTML pages are located at https://doc.edutap.eu
This documentation is written using Sphinx and MyST, a rich and extensible flavour of Markdown for authoring technical and scientific documentation.f
For the local authoring preview, you
-
need Python 3.11 to be installed.
-
clone the repository.
-
run the following commands in the cloned repositories directory:
python -m venv venv source ./venv/bin/activate pip install -r requirements.txt make livehtml -
go to http://localhost:8000 to view the documentation.
Each time you save a file, this part gets re-rendered and reloaded in the browser.
Changes to the main branch are rendered and deployed with GitHub Actions on each push. It uses GitHub Pages for hosting.
The documentation is licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).