Kod źródłowy
Repozytorium kodu źródłowego dla tej dokumentacji.
Uwaga, to jest sposób budowania dokumentacji dla samej aplikacji transpolibre, a nie sposób używania transpolibre.
Zbuduj dokumentację
Aby zbudować tę dokumentację lokalnie, wykonaj następujące czynności.
Instalowanie zależności
Zainstaluj zależności, tak jak w przypadku Debiana:
sudo apt update
sudo apt install python-is-python3 python3-pip python3-venv
Pobierz dokumentację Źródło
git clone https://spacecruft.org/deepcrayon/transpolibre
cd transpolibre/
Konfiguracja Pythona
python -m venv venv
source venv/bin/activate
pip install -U pip setuptools wheel
Dokumentacja Tworzenie pomocy
Aby uzyskać pomoc w budowaniu dokumentacji, uruchom:
make help
Wyświetli się ta pomoc:
Please use 'make <target>' where <target> is one of
clean Remove all build files and directories (including translations)
all Clean and make all targets
gettext_build Build localisation strings for translation
update_locale Update localisation
update_locale_<lang> Update localisation for <lang>
html Build the HTML documentation for all languages
html_<lang> Build HTML documentation for <lang>
latex Build the documentation using LaTeX for all languages
latex_<lang> Build the documentation using LaTeX for <lang>
pdf Build the PDF documentation using LaTeX for all languages
pdf_<lang> Build the PDF documentation using LaTeX for <lang>
ebook Reduce size of PDF for eBook
prepress Reduce size of PDF for prepess
index Copy static docs/index.html to docs/_build/html/index.html
translations Translate from English
Czysty
W ten sposób czyste artefakty kompilacji.
make clean
Zbuduj dokumentację HTML
Aby zbudować dokumentację HTML, uruchom:
make index
make html
Wynikowy kod HTML będzie znajdował się w docs/_build/html/, a plik index.html najwyższego poziomu będzie znajdował się tutaj: docs/index.html.
Zbuduj LaTex PDF
Aby zbudować dokument PDF z kompilacji LaTeX, najpierw zainstaluj zależności (to znacznie więcej niż potrzeba):
sudo apt install texlive-full
Następnie zbuduj dokumenty LaTeX i PDF:
make latex
Zbuduj plik PDF
Aby utworzyć dokument PDF z LaTeX:
make pdf
Wynikowy plik PDF będzie tutaj: docs/_build/latex/en/transpolibre.pdf.
Ebook
Aby znacznie zmniejszyć rozmiar pliku PDF do 150 dpi dla książki elektronicznej, uruchom:
make ebook
Wynikowy plik PDF będzie tutaj: docs/_build/latex/en/transpolibre-ebook-en.pdf.
Prepress
Aby zmniejszyć rozmiar pliku PDF do 300 dpi w celu druku, uruchom:
make prepress
Wynikowy plik PDF będzie tutaj: docs/_build/latex/en/transpolibre-prepress-en.pdf.
Zbuduj całą dokumentację
Zbuduj całą dokumentację, w tym HTML i PDF.
make all
Tłumaczenia
Zobacz README.md aby uzyskać informacje o aktualizowaniu tłumaczeń pakietu.