Web Course Template

This is 's template for a web-based course/workshop content.

Feel free to use it as you please!

---

If you find this template useful, please share it with others! Show your support by giving it a 🌟 using the ⭐-button at the top right of the page.

---

Usage 🛠️

You can simply use this repository as a template for your own project.

The actual content of the web-based course resides under ./source/content folder. There you find the content for the documentation of this template which should serve you both as 🧭 guideline and 💡 inspiration. The design of the web course is defined in ./source/conf.py file.

Head over to the online documentation for detailed instructions how to build your own web course.

Quickstart

1. Clone the repository
2. Create/activate your virtual environment running python3.13 (we recommend using uv for this).
3. Install the dependencies from requirements.txt
4. Edit the content.
5. Build the pages locally with:

   sphinx-build -b html source docs/html -E -A build="pages"
   

   And the slides:

   sphinx-build -b html source docs/html/slides -E -A build="slides"
   

6. View your course locally by opening the files: docs/html/index.hmtl (pages) and docs/html/slides/index.html for the slides.

Contributing 🤝🎉

We welcome contributions to this template! Whether you're fixing bugs 🐛 or typos, adding new features ✨, or improving readability 📚, your help is greatly appreciated!

Before you start, please take a moment to read our CONTRIBUTING.md file. It contains some details and guidelines 📋 on how to structure new content and best practices to help you get started and ensure that your contributions aligned with the project's goals. 🚀

Thank you for considering contributing to this course! You're awesome! 🌟