How studio-17/epitech-subjects works
Project type and purpose
• This repository is primarily a content-and-documentation repository (“Epitech-Subjects”) that hosts all semester subject files for Epitech students.
• It also contains a small Python “AutoDoc” utility (in the AutoDoc/ directory) for automatically generating or updating README files, plus GitHub Actions workflows for link-checking and CI.
File structure analysis
• Top-level:
• .github/workflows – CI pipelines (markdown link-checker).
• AutoDoc/ – Python tool:
– main.py, create_default_readme.py (CLI entry points)
– requirements.txt
– help/ – user instructions
– src/auto_doc.py, param.py, scrapper.py, type_enum.py, writter.py (core modules)
• README.md – project overview and table of content links.
• assets/ – static images for the README.
• Semester-0…Semester-5 – hierarchical tree of subject directories and files. These are static artifacts, not active code.
Key insights from README
• The project is not a web application itself but the source repo for a static website (hosted separately on GitHub Pages).
• README describes modules (semesters), credits, and links to individual subject directories.
a. Main components
• Git repository (GitHub)
• GitHub Actions workflows (CI)
• AutoDoc Python utility
• Static content directories (Semester-X)
• GitHub Pages (external hosting)
b. Relationships and interactions
1. Developer → GitHub (push code & content)
2. GitHub → GitHub Actions:
• markdown-links.yml validates README links.
3. AutoDoc CLI (invoked manually or as part of CI) reads source directories:
• param.py parses CLI flags
• scrapper.py crawls directory tree & extracts metadata
• auto_doc.py orchestrates workflow
• writter.py writes/updates README.md files
4. Output: updated README.md & assets in the repo
5. GitHub Pages reads the final static files and publishes the website
c. Architectural patterns / principles
• Modular design in AutoDoc: separation of concerns between scraping, parameter handling, and writing.
• Event-driven CI: workflows trigger on push or pull_request.
• Static site deployment: content is pure markdown/static assets, no dynamic backend.
d. Key technologies/frameworks
• Python 3 (AutoDoc)
• PyPI dependencies (listed in requirements.txt)
• GitHub Actions for CI/CD
• Markdown for content
• GitHub Pages for hosting