EIP-Peltomappi

Kehittäminen

1. Luo Python-virtuaaliympäristö:

python -m venv .venv

2. Aktivoi virtuaaliympäristö.

Windows:

.\.venv\Scripts\activate

Linux/macOS:

source ./.venv/bin/activate

Asenna uv-työkalu projektin hallinnointiin:

pip install uv

Päivitä projektiympäristö (asentaa tarvittavat riippuvuudet):

uv sync --all-groups

Asenna pre-commit hook:

pre-commit install

Ohjeistuksen kehittäminen

Ennen ohjeistuksen kehittämistä toista ensin aiemmat komennot. Kun olet toistanut vaiheet kerran, ohjeistusta voi kehittää. Varmista kuitenkin, että virtuaaliympäristö on aktivoitu.

MkDocs

Käynnistä palvelin samassa kansiossa, jossa tiedosto mkdocs.yml sijaitsee:

mkdocs serve

Sivut näkyvät selaimessa osoitteessa http://127.0.0.1:8000 tai localhost:8000.

Sivut voi myös kääntää:

mkdocs build

Tällöin sivut löytyy site kansiosta, josta voit myös avata ne selaimeen.