Instalacja

Generator wymaga Pythona 3.11 lub nowszego. Nie wymaga dodatkowych pakietów Pythona. Ta strona należy do częściowego polskiego przykładu; pełny podręcznik można otworzyć, wybierając English w przełączniku języka.

Generowanie dokumentacji#

W głównym katalogu repozytorium uruchom:

python3 build.py

Polecenie sprawdza źródła, zapisuje witrynę w dist/ i tworzy archiwum artifacts/manual-site.tar.gz. Plik manual/languages.json określa języki angielski i polski oraz wybiera angielski jako domyślny.

Podgląd lokalny#

Po wygenerowaniu dokumentacji uruchom serwer plików statycznych:

python3 -m http.server --directory dist 8000

Otwórz http://localhost:8000/pl/, aby przeczytać polski przykład. Adres http://localhost:8000/ przekierowuje do domyślnego języka pod /en/. Zatrzymaj serwer skrótem Ctrl-C.

Archiwum offline#

Aby przygotować dokumentację do czytania bez serwera, uruchom:

python3 build.py --offline-archive artifacts/manual-site-offline.zip

Rozpakuj ZIP, otwórz manual-site-offline/index.html i wybierz Polski. Strona główna archiwum pozwala wybrać język bez automatycznego przekierowania. Nie otwieraj strony bezpośrednio wewnątrz archiwum; rozpakowane pliki muszą pozostać razem.

Zmieniaj treść w manual/pl/ lub manual/en/, a następnie ponownie generuj witrynę. Pliki wynikowe są zastępowane przy kolejnym generowaniu.

Wróć do wprowadzenia.