Environment Requirements
Development Environment Overview
Tämä osio kokoaa yhteen kaikki projektin kehitysympäristöön liittyvät vaatimukset ja suositukset.
Tavoitteena on varmistaa, että dokumentaatio rakentuu luotettavasti ja että kehittäjät käyttävät yhtenäistä, toimivaa ympäristöä riippumatta käyttöjärjestelmästä tai työkaluketjusta.
Environment Requirements ‑kansio sisältää:
- Python‑version vaatimukset ja perustelut
- MkDocs Material ‑version rajoitteet ja yhteensopivuus
- CSS‑patchit, joita tarvitaan Material 9.x ‑sarjan kanssa
- Requirements‑tiedoston riippuvuudet
- Ohjeet virtuaaliympäristön luomiseen ja hallintaan
Miksi tämä osio on tärkeä?
Dokumentaation rakennustyökalut (MkDocs, Material, laajennukset) kehittyvät nopeasti.
Jotta projektin dokumentaatio pysyy:
- toimivana,
- yhteensopivana,
- ennustettavana,
- helposti ylläpidettävänä,
on tärkeää, että kehitysympäristö on määritelty selkeästi ja että kaikki käyttävät samoja versioita.
Sisältö
Tämä kansio sisältää seuraavat tiedostot:
1. Python Version Requirement
Selittää, miksi projekti käyttää Python 3.11 ‑versiota ja miten venv luodaan sillä.
2. MkDocs Material Version Requirement
Kuvaa, miksi mkdocs-material 10.x ‑sarjaa ei ole julkaistu ja miksi käytämme versiota 9.7.1.
3. Sticky Tabs CSS Patch
Tarjoaa toimivan CSS‑korjauksen Material 9.x ‑sarjan DOM‑rakenteelle, jotta navigation.tabs.sticky toimii odotetusti.
4. Requirements File
Listaa projektin riippuvuudet ja niiden vähimmäisversiot.
Kenelle tämä osio on tarkoitettu?
- Kehittäjille, jotka rakentavat dokumentaatiota paikallisesti
- CI/CD‑putkien ylläpitäjille
- RepoStage‑ympäristön käyttäjille
- Kaikille, jotka haluavat ymmärtää projektin teknisen perustan
Yhteenveto
Environment Requirements ‑kansio toimii projektin teknisenä perustana.
Se varmistaa, että dokumentaatio:
- rakentuu luotettavasti
- toimii samalla tavalla kaikilla koneilla
- on yhteensopiva MkDocs‑ekosysteemin kanssa
- pysyy ylläpidettävänä pitkällä aikavälillä