Belgelerin İnşası

Buradaki belgeler reStructuredText formatında yazılmış ve Sphinx kullanılarak derlenmiştir. Belgeleri derlemek için öncelikle Sphinx'i kurmalısınız. Sphinx, Python'un 3.10 ve daha yukarı versiyonlarını desteklemektedir.

Belgelere katkıda bulunmayı planlıyorsanız önce CONTRIBUTING.md dosyasına başvurun.

Debian/Ubuntu

Bir Python3.10+ sürümünün, pip'in ve make'in sisteminizde kurulu olduğundan emin olduktan sonra projenin kök dizinine gidip bu komut ile gerekli kütüphaneleri kurabilirsiniz:

python3 -m pip install -r requirements.txt

Daha sonra yine projenin kök dizinde bu komutu çalıştırarak belgeleri inşa edebilirsiniz:

make html

Belgeleri inşa ettikten sonra /scripts/move_documents.py betiği /build/ içindeki gerekli dosya ve klasörleri /docs/ içine taşıyacaktır:

python3 ./scripts/move_documents.py

Bu şekilde inşa ettiğiniz dökümanı görüntülemek için /docs/index.html dosyasını tarayıcınız ile açabilirsiniz.

Windows

Python'un 3.10 veya daha yüksek bir sürümünün bilgisayarınızda kurulu olduğundan ve python.exe'nin PATH'de bulunduğundan emin olduktan sonra projenin kök dizinine gidip bu kodu cmd.exe'de çalıştırarak gerekli kütüphaneleri kurabilirsiniz:

python -m pip install -r requirements.txt

Yükleme işlemi başarıyla gerçekleşmiş ise şu komut size Sphinx'in versiyonunu verecektir:

sphinx-build --version

Daha sonra yine projenin kök dizinde bu komutu çalıştırarak belgeleri inşa edebilirsiniz:

make.bat html

Belgeleri inşa ettikten sonra /scripts/move_documents.py betiği /build/ içindeki gerekli dosya ve klasörleri /docs/ içine taşıyacaktır:

python scripts/move_documents.py

Bu şekilde inşa ettiğiniz dökümanı görüntülemek için /docs/index.html dosyasını tarayıcınız ile açabilirsiniz.

Diğer işletim sistemleri

Diğer işletim sistemlerinde Sphinx kurulumu ve ayrıntılı bilgi için buraya bakabilirsiniz.

---

Belgeleri diğer formatlarda inşa etme

Önce yukarıdaki adımları takip edip Sphinx'in kurulumunu gerçekleştirin.

Belgeleri diğer formatlarda inşa ettikten sonra da /scripts/move_documents.py betiğini çalıştırmayı unutmayın.

Tek parça HTML olarak inşa etme

Debian/Ubuntu'da:

make singlehtml

Windows'ta:

make.bat singlehtml

HTML dosyası /build/singlehtml/ dizininde index.html adı ile oluşacaktır.

EPUB olarak inşa etme

Debian/Ubuntu'da:

make epub

Windows'ta:

make.bat epub

EPUB dosyası /build/epub/ dizininde Yazbel Python Belgeleri.epub adı ile oluşacaktır.

PDF olarak inşa etme

Belgeleri PDF olarak inşa edebilmek için pdflatex uygulamasına ihtiyacınız olacak. MikTeX veya TeX Live gibi bir TeX dağıtımını indirerek bu uygulamayı edinebilirsiniz. Bu dağıtımların belgerin inşası için gerekli eklentiler ile birlikte 800 Megabyte gibi bir disk alanı kaplayabileceğini unutmayın. TeX dağıtımının kurulumunda bir problem yaşarsanız buraya başvurabilirsiniz.

Eğer Windows kullanıyorsanız ve winget CLI uygulamasına sahipseniz MikTeX dağıtımını indirmek için bu yolu da izleyebilirsiniz:

winget install MiKTeX.MiKTeX
winget install StrawberryPerl.StrawberryPerl # MiKTeX aynı zamanda bir Perl kurulumu gerektirir

Uygun bir TeX dağıtımını kurduktan sonra pdflatex'in bulunduğu dizinin PATH'de bulunduğundan emin olun.

Debian/Ubuntu'da:

make latexpdf

Windows'ta:

make.bat latexpdf

Herhangi bir hata oluşmazsa PDF dosyası /build/latex/ dizininde yazbelpythonbelgeleri.pdf adı ile oluşacaktır.