Bu, Ubuntu Online, Fedora Online, Windows çevrimiçi emülatörü veya MAC OS çevrimiçi emülatörü gibi birden fazla ücretsiz çevrimiçi iş istasyonumuzdan birini kullanarak OnWorks ücretsiz barındırma sağlayıcısında çalıştırılabilen sfenks oluşturma komutudur.
Program:
ADI
sphinx-build - Sphinx dokümantasyon oluşturma aracı
SİNOPSİS
sfenks yapımı [seçenekleri]kaynak dizin>dış yön> [dosya adları ...]
TANIM
sfenks yapımı içindeki dosyalardan belgeler oluşturur. ve içine yerleştirir
.
sfenks yapımı arar /conf.py yapılandırma ayarları için
sfenks-hızlı başlangıç(1) dahil olmak üzere şablon dosyaları oluşturmak için kullanılabilir. konf.py.
sfenks yapımı farklı formatlarda dokümantasyon oluşturabilir. tarafından bir biçim seçilir
komut satırında oluşturucu adının belirtilmesi; varsayılan olarak HTML'dir. İnşaatçılar da
dokümantasyon işleme ile ilgili diğer görevleri yerine getirmek.
Varsayılan olarak, eski olan her şey yerleşiktir. Yalnızca seçilen dosyalar için çıktı alınabilir
bireysel dosya adları belirtilerek oluşturulur.
Mevcut inşaatçıların listesi:
html HTML dosyası oluşturma. Bu, varsayılan oluşturucudur.
dirhtml
"index.html" adlı her HTML dosyasıyla ayrı bir HTML dosyası oluşturma
dizin.
teklihtml
Tüm içeriği tek bir HTML dosyasında içeren HTML dosyası oluşturma.
htmlyardım
CHM (derlenmiş yardım dosyaları) oluşturma için dosyalar oluşturur.
yardım Qt yardım koleksiyonu oluşturma için dosyalar oluşturur.
geliştirici
GNOME Devhelp yardım görüntüleyici için dosyalar oluşturur.
lateks Bir PDF belgesine derlenebilen LaTeX çıktısı üretir.
adam Manuel sayfalar oluşturur.
texinfo
tarafından işlenebilen Texinfo çıktısı üretir. bilgi oluştur Bilgi oluşturmak için
belge.
epub HTML çıktısının bir ePub e-kitap sürümünü oluşturur.
metin Belgelerin düz metin sürümünü oluşturur.
gettext
İçerik çevirisi için Gettext mesaj katalogları oluşturur.
değişiklikler
Geçerli sürüm için değiştirilen/eklenen/kullanımdan kaldırılan öğeleri listeleyen HTML dosyaları oluşturur
belgelenmiş projenin
bağlantı denetimi
Kaynaktaki tüm dış bağlantıların bütünlüğünü kontrol eder.
turşu / json
Web uygulamalarında kullanılmak üzere serileştirilmiş HTML dosyaları oluşturur.
xml Docutils'e özgü XML dosyaları oluşturur.
psödoxml
Dahili görüntüleyen kompakt, güzel basılmış "sözde-XML" dosyaları oluşturur.
ara belge ağaçlarının yapısı.
SEÇENEKLER
-b
Kullanılacak oluşturucu; varsayılan olarak html'dir. Yukarıdaki inşaatçıların tam listesine bakın.
-a Tüm dosyalar için çıktı oluşturun; bu seçenek olmadan yalnızca yeni ve değiştirilmiş çıktılar için çıktı
dosyalar oluşturulur.
-E Önbelleğe alınmış dosyaları yoksay, tüm kaynak dosyaları diskten yeniden okumaya zorlar.
-d
Önbelleğe alınmış dosyaların yolu; varsayılan /.belgeler.
-j Mümkün olduğunda N süreçlerle paralel olarak oluşturun.
-c
yerine belirtilen yolda conf.py dosyasını bulun. .
-C Hiçbir conf.py dosyasının kullanılmayacağını belirtin. Yapılandırma yalnızca ayarlanabilir
-D seçeneği ile.
-D
Yapılandırma dosyasındaki bir ayarı geçersiz kılın.
-t
Tanımlama etiket "yalnızca" bloklarda kullanım için.
-A
HTML şablonlarına bir değer iletin (yalnızca HTML oluşturucular için).
-n Nitelikli modda çalıştırın, tüm eksik referanslar hakkında uyarın.
-v Ayrıntıyı artırın (tekrarlanabilir).
-N Renkli çıktıyı önleyin.
-q Sessiz çalışma, sadece uyarıları ve hataları stderr'de yazdırın.
-Q Çok sessiz çalışma, hatalar dışında hiçbir şey yazdırmayın.
-w
Verilen dosyaya stderr'e ek olarak uyarıları ve hataları yazın.
-W Uyarıları hatalara dönüştürün.
-T İstisnada tam geri izlemeyi göster.
-P İstisna üzerinde Pdb'yi çalıştırın.
onworks.net hizmetlerini kullanarak sfenks oluşturmayı çevrimiçi kullanın