-
Notifications
You must be signed in to change notification settings - Fork 164
Belge, detaylı bir şekilde gözden geçirildi. #233
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
a80a2fd
192c13d
2cd50ce
d5b0266
eaca83d
666a005
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,126 +1,152 @@ | ||
| # Belgelerin İnşası | ||
|
|
||
| Buradaki belgeler [reStructuredText](http://docutils.sourceforge.net/rst.html) formatında yazılmış ve [Sphinx](http://www.sphinx-doc.org/) 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. | ||
| Bu belgeler [reStructuredText](http://docutils.sourceforge.net/rst.html) formatında yazılmış ve [Sphinx](http://www.sphinx-doc.org/) kullanılarak oluşturulmuştur. Belgeleri derlemek için öncelikle Sphinx'i kurmanız gerekmektedir. Sphinx, Python 3.10 ve üzeri sürümleri destekler. | ||
|
|
||
| Belgelere katkıda bulunmayı planlıyorsanız önce [`CONTRIBUTING.md`](CONTRIBUTING.md) dosyasına başvurun. | ||
| Belgelere katkıda bulunmayı düşünüyorsanız, öncelikle [`CONTRIBUTING.md`](CONTRIBUTING.md) dosyasını incelemenizi öneririz. | ||
|
|
||
| ## Debian/Ubuntu | ||
| --- | ||
|
|
||
| ## Gereksinimler ve Kurulum | ||
|
|
||
| ### Debian/Ubuntu | ||
|
|
||
| 1. **Gerekli Araçlar:** | ||
| - Python 3.10 veya daha üstü sürüm | ||
| - `pip` | ||
| - `make` | ||
|
|
||
| 2. **Kurulum Adımları:** | ||
|
|
||
| Projenin kök dizinine gidin ve gerekli kütüphaneleri şu komutla yükleyin: | ||
|
|
||
| ```shell | ||
| python3 -m pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| Daha sonra belgeleri derlemek için şu komutu çalıştırın: | ||
|
|
||
| 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: | ||
| ```shell | ||
| make html | ||
| ``` | ||
|
|
||
| ```shell | ||
| python3 -m pip install -r requirements.txt | ||
| ``` | ||
| Belgeleri inşa ettikten sonra, `/scripts/move_documents.py` betiği, `/build/` dizinindeki gerekli dosyaları `/docs/` dizinine taşıyacaktır: | ||
|
|
||
| Daha sonra yine projenin kök dizinde bu komutu çalıştırarak belgeleri inşa edebilirsiniz: | ||
| ```shell | ||
| python3 ./scripts/move_documents.py | ||
| ``` | ||
|
|
||
| ```shell | ||
| make html | ||
| ``` | ||
| Sonuç olarak, oluşturulan belgeleri görüntülemek için `/docs/index.html` dosyasını tarayıcınızda açabilirsiniz. | ||
|
|
||
| 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: | ||
| --- | ||
|
|
||
| ### Windows | ||
|
|
||
| ```shell | ||
| python3 ./scripts/move_documents.py | ||
| ``` | ||
| 1. **Gerekli Araçlar:** | ||
| - Python 3.10 veya daha üstü sürüm | ||
| - PATH ortam değişkenine eklenmiş `python.exe` | ||
|
|
||
| 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. | ||
| 2. **Kurulum Adımları:** | ||
|
|
||
| ## Windows | ||
| Projenin kök dizinine gidin ve gerekli kütüphaneleri şu komutla yükleyin: | ||
|
|
||
| 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: | ||
| ```shell | ||
| python -m pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| ```shell | ||
| python -m pip install -r requirements.txt | ||
| ``` | ||
| Yüklemenin başarılı olduğunu doğrulamak için aşağıdaki komutu çalıştırarak Sphinx sürümünü kontrol edin: | ||
|
|
||
| Yükleme işlemi başarıyla gerçekleşmiş ise şu komut size Sphinx'in versiyonunu verecektir: | ||
| ```shell | ||
| sphinx-build --version | ||
| ``` | ||
|
|
||
| ```shell | ||
| sphinx-build --version | ||
| ``` | ||
| Belgeleri inşa etmek için şu komutu çalıştırın: | ||
|
|
||
| Daha sonra yine projenin kök dizinde bu komutu çalıştırarak belgeleri inşa edebilirsiniz: | ||
| ```shell | ||
| make.bat html | ||
| ``` | ||
|
|
||
| ```shell | ||
| make.bat html | ||
| ``` | ||
| Belgeler oluşturulduktan sonra, `/scripts/move_documents.py` betiği ile dosyaları taşıyın: | ||
|
|
||
| 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: | ||
| ```shell | ||
| python scripts/move_documents.py | ||
| ``` | ||
|
|
||
| ```shell | ||
| python scripts/move_documents.py | ||
| ``` | ||
| Oluşturulan belgeleri görmek için `/docs/index.html` dosyasını tarayıcınızda açabilirsiniz. | ||
|
|
||
| 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 İşletim Sistemleri | ||
|
|
||
| Diğer işletim sistemlerinde Sphinx kurulumu ve ayrıntılı bilgi için [buraya](https://www.sphinx-doc.org/en/master/usage/installation.html) bakabilirsiniz. | ||
| Farklı işletim sistemlerinde Sphinx'in kurulumu hakkında detaylı bilgi için [Sphinx'in resmi kurulum belgelerini](https://www.sphinx-doc.org/en/master/usage/installation.html) inceleyebilirsiniz. | ||
|
|
||
| --- | ||
|
|
||
| ## Belgeleri diğer formatlarda inşa etme | ||
| ## Diğer Formatlarda Belgeleri İnşa Etme | ||
|
|
||
| Sphinx ile belgeleri farklı formatlarda oluşturabilirsiniz. Aşağıdaki adımları izleyerek belgeleri ihtiyaçlarınıza uygun şekilde inşa edebilirsiniz. | ||
|
|
||
| Önce yukarıdaki adımları takip edip Sphinx'in kurulumunu gerçekleştirin. | ||
| ### Tek Parça HTML | ||
|
|
||
| Belgeleri diğer formatlarda inşa ettikten sonra da `/scripts/move_documents.py` betiğini çalıştırmayı unutmayın. | ||
| - **Debian/Ubuntu:** | ||
|
|
||
| ### Tek parça HTML olarak inşa etme | ||
| ```shell | ||
| make singlehtml | ||
| ``` | ||
|
|
||
| Debian/Ubuntu'da: | ||
| - **Windows:** | ||
|
|
||
| ```shell | ||
| make singlehtml | ||
| ``` | ||
| ```shell | ||
| make.bat singlehtml | ||
| ``` | ||
|
|
||
| Windows'ta: | ||
| Oluşturulan HTML dosyası `/build/singlehtml/index.html` yolunda bulunacaktır. | ||
|
|
||
| ```shell | ||
| make.bat singlehtml | ||
| ``` | ||
| --- | ||
|
|
||
| HTML dosyası `/build/singlehtml/` dizininde `index.html` adı ile oluşacaktır. | ||
| ### EPUB | ||
|
|
||
| ### EPUB olarak inşa etme | ||
| - **Debian/Ubuntu:** | ||
|
|
||
| Debian/Ubuntu'da: | ||
| ```shell | ||
| make epub | ||
| ``` | ||
|
|
||
| ```shell | ||
| make epub | ||
| ``` | ||
| - **Windows:** | ||
|
|
||
| Windows'ta: | ||
| ```shell | ||
| make.bat epub | ||
| ``` | ||
|
|
||
| ```shell | ||
| make.bat epub | ||
| ``` | ||
| EPUB dosyası `/build/epub/Yazbel Python Belgeleri.epub` olarak kaydedilecektir. | ||
|
|
||
| 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](https://miktex.org/) veya [TeX Live](https://www.tug.org/texlive/) 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](https://www.sphinx-doc.org/en/master/usage/builders/index.html#sphinx.builders.latex.LaTeXBuilder) başvurabilirsiniz. | ||
| PDF formatında belgeleri oluşturmak için bir TeX dağıtımı (ör. [MikTeX](https://miktex.org/) veya [TeX Live](https://www.tug.org/texlive/)) kurmanız gereklidir. Bu dağıtımlar genellikle ek eklentilerle birlikte kurulur ve yaklaşık 800 MB disk alanı gerektirir. | ||
|
|
||
| > Eğer Windows kullanıyorsanız ve [`winget`](https://github.com/microsoft/winget-cli) CLI uygulamasına sahipseniz MikTeX dağıtımını indirmek için bu yolu da izleyebilirsiniz: | ||
| > **Windows Kullanıcıları için:** Eğer [`winget`](https://github.com/microsoft/winget-cli) kuruluysa, MikTeX'i şu komutlarla yükleyebilirsiniz: | ||
| > | ||
| > ```shell | ||
| > winget install MiKTeX.MiKTeX | ||
| > winget install StrawberryPerl.StrawberryPerl # MiKTeX aynı zamanda bir Perl kurulumu gerektirir | ||
| > winget install StrawberryPerl.StrawberryPerl # MikTeX ayrıca bir Perl kurulumu gerektirir | ||
| > ``` | ||
| Uygun bir TeX dağıtımını kurduktan sonra `pdflatex`'in bulunduğu dizinin PATH'de bulunduğundan emin olun. | ||
| TeX dağıtımı kurulduktan sonra `pdflatex` uygulamasının PATH ortam değişkeninde yer aldığından emin olun. | ||
| Belgeleri PDF formatında oluşturmak için: | ||
| - **Debian/Ubuntu:** | ||
| Debian/Ubuntu'da: | ||
| ```shell | ||
| make latexpdf | ||
| ``` | ||
| ```shell | ||
| make latexpdf | ||
| ``` | ||
| - **Windows:** | ||
|
|
||
| Windows'ta: | ||
| ```shell | ||
| make.bat latexpdf | ||
| ``` | ||
|
|
||
| ```shell | ||
| make.bat latexpdf | ||
| ``` | ||
| Oluşturulan PDF dosyası `/build/latex/yazbelpythonbelgeleri.pdf` yolunda bulunacaktır. | ||
|
|
||
| Herhangi bir hata oluşmazsa PDF dosyası `/build/latex/` dizininde `yazbelpythonbelgeleri.pdf` adı ile oluşacaktır. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Normalde bir aksaklık olursa kişi adımları doğru takip etmediğinden şüphelenir. Ama PDF inşası sıkıntılı bir süreç, bu adımlar her senaryoyu karşılamıyor da olabilir. Buradaki vurgunun sebebi bu manayı iletmekti aslında. "PDF inşası sürecinde sorun yaşarsanız repo'da issue açabilirsiniz" diye ekleyelim mi? |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bu iki notu silmeye gerek var mı? Özellikle
move_documents.pynotu kalmalı diye düşünüyorum zira bu betik çalıştırılmadığında yeni inşa edilen HTML, EPUB ve PDF dosyaları repo'ya dahil edilmiyor.buildklasörü.gitignore'a dahil çünkü.