Bu işlem, seçtiğiniz dizinde HTML dokümanları oluşturacaktır. Bu işlemler, oluşturucunun adına `create` komutunu çalıştırarak gerçekleştirilebilir. Sphinx kaynak veri dosyalarında, standart reStructuredText'in çoğu özelliğini kullanabilirsiniz.
- Sphinxdoc/sphinx-latexpdf, TeXLive paketlerini içermektedir.
- En yeni bileşeni analiz ederken __all__ ifadesini kullanmaktan kaçının, böylece belgeleme yapabilirsiniz.
- Bu değer, yeni docstring'lerin kalıtımını kontrol eder. Eğer bu değer True olarak ayarlanırsa, sınıflar için en yeni docstring geçerli olur; aksi takdirde, açıkça belirtmezseniz, ebeveynlerinizden gelen bilgileri deneyin.
- Bu yalnızca yeni miras alma seçeneği değerlendirilirken ortaya çıkar.
Ballonix kumarhanesi | Kurmak¶
Autodoc, geçerli bir docstring'i okuyup işlediğinde üretilir. Bu nedenle, yeni docstring'lerin kalıtımını kontrol etmeye değer. Yeni docstring'in gruplara veya adımlara sahip olması veya açıkça ayarlanması, ebeveynlerden miras alınır. Dosyada değerlendirilmeyen devam eden takma ad türleriyle aşinadır. Aşırı yüklenmiş özellikler veya adımlar, açıklamada tür ipuçları içermez çünkü bir parametre listesiyle tüm olası aşırı yüklemeleri doğru bir şekilde göstermek imkansızdır.
Liman işçisi¶
Mükemmel bir Sphinx düz metin belgesinin temel kümesi, kaynak dizini olarak adlandırılır. Buradaki işlemleri tamamladıktan sonra, Sphinx tarafından kullanılan varsayılan işaretleme yapısı olan reStructuredText'e yeni bir giriş içeren kurulum kılavuzuna gidebilirsiniz. Bu dosyanın amacı, Sphinx'in ne olduğunu ve nasıl kullanılabileceğini size hızlı bir şekilde göstermektir.
- Sphinx-contriborganization kullanıcıları tarafından katkıda bulunulan çok sayıda eklenti bulacaksınız.
- Gelecek sınıftaki özel kişiler için, 'dunder' markaları olarak etiketlenmiş otomatik belgeler oluşturun. Bu, Elizabeth.g. gibi çift vurguyla başlayan tüm isimlerden oluşur.
- Ayrıca, mevcut olduğunda, yeni eşleşen envvar yönergesine iyi bir bağlantı oluşturur.
Çapraz referanslama konuları¶
Yeni sunulan dosya adı, genellikle modern kaynak Ballonix kumarhanesi dosyasının bulunduğu en yeni listeye göre belirlenir; mutlak (/) ile başlayan dosyalar için ise ana kaynak listesine göre alınır. Belirtilen belgeye bağlantı; yeni belge kimliği, Windows için bile her zaman büyük/küçük harf duyarlı olan göreceli veya mutlak bir yol olacaktır. Yalnızca en yeni "genetik" seçeneği dikkate alındığında yayınlanır. Temeller, deneyim işleyicisinin Sphinx'in çıktıya ne yerleştireceğini değiştirmek için kullanabileceği kategorilerin bir özetidir. Hiçbir satır eşleşmezse, yeni sonuçlanan belge dizisi boş olur, bu nedenle "keepempty" geçerli olmadığı sürece hiçbir değişiklik yapılmaz.
Bir alan adı aslında, ona ait olan ve bu nesnelerin oluşturulması ve referans açıklamaları için işaretleme ile detaylandırılmış bir nesne türleri koleksiyonudur. Sphinx'in temel amacı, neredeyse her alanda (çok standart bir deneyim içinde) işleri kolaylaştırmaktır. Ancak, sphinx-quickstart yazılımı mükemmel bir Makefile içerir ve hayatı sizin için kolaylaştıran bir make.bat dosyası oluşturabilirsiniz.
Konturlar, zincirleme bir liste oluşturur – kendi işlenmiş docstring'inizin yeni ana hatları – deneyim işleyici, Sphinx'in üretimde bıraktığı şeyleri değiştirmek için kurulumu değiştirebilir. Bu, tedarik parolanız tür açıklamalarıyla uyumlu değilse, örneğin yalnızca tür açıklamaları kullanıyorsa veya herhangi bir tür ipucuyla uyumlu değilse devre dışı bırakılır. Kayıp tür açıklamalarını iyileştirmek için kaynak koddan uzak ifadeler, Gerçek durumda.
Yeni modülü analiz ederken __all__ kullanımından kaçının, böylece dosyalama yapabilirsiniz. Alternatif olarak, autodoc, anlamdan sonra yepyeni aralıkta iyi bir docstring'i de anlayabilir. NumPy veya Bing'in reStructuredText'ten daha fazla docstring oluşturmasını istiyorsanız, napoleon uzantısını da etkinleştirebilirsiniz. napoleon, autodoc tekniklerinden önce docstring'leri doğru reStructuredText'e dönüştüren bir önişlemcidir. Yöntem boyunca bir kılavuz olarak yardımcı olacak rastgele yemek formülleri oluşturmak için kurgusal bir yazılım koleksiyonu oluşturacaksınız, amacınız bunu düzgün bir şekilde belgelemektir. Genellikle paket python3-sphinx, python-sphinx veya sphinx olarak bilinir. Daha fazla bilgi için thesphinx-create son sayfasına bakın.