How multimodelling/documentation works
Project type and purpose
• This repository is purely a documentation project built with Sphinx (ReadTheDocs‑style). Its sole purpose is to generate and host the Multimodelling Documentation as a static website on ReadTheDocs.
File structure
• Top‑level:
• docs/ ← Sphinx source trees
• requirements.txt
• .readthedocs.yaml, README.md, CONTRIBUTE.md, LICENSE
• Under docs/source/: multiple subfolders organizing content by audience and domain:
• enduser/
• energy_models/
• example_use_cases/
• scientific/
• technical/
• installation/, introduction/, terminology/
• docs/ contains build scripts (Makefile, make.bat) and Sphinx conf.py in docs/source.
README for additional insights
• The project is built locally with “make html” in docs/, producing HTML under docs/build/html, and on commit/push ReadTheDocs auto‑builds and hosts the site.
a. Main components to represent
1. Developer Workstation
– Local code checkout (Git)
– docs/ source tree (reStructuredText files, conf.py)
– Local build tooling (Makefile, Python + Sphinx)
2. Version Control (GitHub)
– docs/ and config (.readthedocs.yaml, requirements.txt)
3. Continuous Build Service (ReadTheDocs)
– Pulls from GitHub on each push
– Installs dependencies
– Runs Sphinx build
4. Build Outputs
– HTML files (docs/build/html)
5. Hosting / CDN
– Serves the generated static site at https://multimodelling.readthedocs.io/
b. Relationships & data flows
• Developer edits docs locally → runs make html → preview in browser
• Developer pushes to GitHub → Git hook triggers ReadTheDocs build
• ReadTheDocs clones, installs requirements, runs Sphinx → outputs HTML
• ReadTheDocs deploys HTML to the public URL
c. Architectural patterns & design principles
• Static‑site generation pipeline
• Git‑triggered CI/CD (auto‑deploy)
• Modular content organization by audience/domain (folder per section)
d. Relevant technologies
• Sphinx (conf.py, rst files)
• Python (docs dependencies in requirements.txt)
• Make (Makefile, make.bat)
• GitHub (source repo)
• ReadTheDocs (build + hosting)