Python
Ağ işlemleri
Lisans: Belirtilmemis
Sphinx Python Dokümantasyon Yapılandırma Dosyası
Orijinal Kod Adı:
Python — conf.py
Projenin teknik belgelerini HTML/PDF olarak derleyen Sphinx aracının tema, eklenti ve sürüm ayarlarını tanımlar. Dosya ölçeği: 29 satır (~722 bayt). Kullandığı modül/paketler: datetime, os, xlrd.info. Kaynak depo: python-excel/xlrd.
💡 Püf Noktaları:
• Dokümantasyon sürümünü (`version`/`release`) manuel çoğaltmak yerine paket sürüm dosyasından dinamik okuyarak senkronize tutun.
• Bozuk iç/dış dokümantasyon linklerini yakalamak için CI hattında `sphinx-build -b linkcheck` adımını çalıştırın.
• Üretilen statik `_build/html` çıktısını sürüm kontrolüne sokmak yerine `.gitignore` ile hariç tutun ve CI üzerinden yayınlayın.
🛠️ Uygulama Tarifi:
1. Dokümantasyon araçlarını kurun: `pip install sphinx` (ve varsa `conf.py` içindeki özel tema/eklenti paketlerini yükleyin).
2. Dosyayı dokümantasyon köküne (`docs/conf.py`) yerleştirip proje adı, sürüm ve `extensions` listesini güncelleyin.
3. `sphinx-build -b html docs docs/_build/html` komutuyla teknik belgeleri HTML olarak derleyin.
💡 Püf Noktaları:
• Dokümantasyon sürümünü (`version`/`release`) manuel çoğaltmak yerine paket sürüm dosyasından dinamik okuyarak senkronize tutun.
• Bozuk iç/dış dokümantasyon linklerini yakalamak için CI hattında `sphinx-build -b linkcheck` adımını çalıştırın.
• Üretilen statik `_build/html` çıktısını sürüm kontrolüne sokmak yerine `.gitignore` ile hariç tutun ve CI üzerinden yayınlayın.
🛠️ Uygulama Tarifi:
1. Dokümantasyon araçlarını kurun: `pip install sphinx` (ve varsa `conf.py` içindeki özel tema/eklenti paketlerini yükleyin).
2. Dosyayı dokümantasyon köküne (`docs/conf.py`) yerleştirip proje adı, sürüm ve `extensions` listesini güncelleyin.
3. `sphinx-build -b html docs docs/_build/html` komutuyla teknik belgeleri HTML olarak derleyin.
Dikkat Edilmesi Gerekenler:
• [Lisans & Telif] Kaynak kodun lisans türü net değildir (Sınırlı Önizleme); ticari projede veya dağıtımda kaynak depo telif koşullarını mutlaka doğrulayın.
• [Hata Yönetimi] Üretime almadan önce geçersiz girdi, eksik ortam değişkeni ve bağlantı kesilmesi senaryoları için istisna/hata loglamasını doğrulayın.
• [Sürüm & Test] Bağımlılık ve çalışma ortamı sürümlerini (PHP/Node/Python/DB) hedef sunucuyla eşleştirip test ortamında doğruladıktan sonra dağıtın.
• [Lisans & Telif] Kaynak kodun lisans türü net değildir (Sınırlı Önizleme); ticari projede veya dağıtımda kaynak depo telif koşullarını mutlaka doğrulayın.
• [Hata Yönetimi] Üretime almadan önce geçersiz girdi, eksik ortam değişkeni ve bağlantı kesilmesi senaryoları için istisna/hata loglamasını doğrulayın.
• [Sürüm & Test] Bağımlılık ve çalışma ortamı sürümlerini (PHP/Node/Python/DB) hedef sunucuyla eşleştirip test ortamında doğruladıktan sonra dağıtın.
import datetime
import os
from xlrd.info import __VERSION__
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
intersphinx_mapping = {'http://docs.python.org': None}
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
source_suffix = '.rst'
master_doc = 'index'
project = u'xlrd'
copyright = (
'2005-2019 Stephen John Machin, Lingfo Pty Ltd. '
'2019-%s Chris Withers'
) % datetime.datetime.now().year
version = release = __VERSION__
exclude_patterns = ['_build']
pygments_style = 'sphinx'
if on_rtd:
html_theme = 'default'
else:
html_theme = 'classic'
htmlhelp_basename = project+'doc'
intersphinx_mapping = {'python': ('http://docs.python.org', None)}
autodoc_member_order = 'bysource'