Bu, seçtiğiniz make dizininde HTML dokümanları oluşturabilir. Bunlar, oluşturucunuzun etiketine create komutunu çalıştırarak gerçekleştirilebilir. Sphinx kaynak dokümanlarında, standardreStructuredText ile birlikte gelen seçenekleri kullanabilirsiniz.

• Sphinxdoc/sphinx-latexpdf, TeXLive paketlerini içermektedir.
• En yeni bileşeni analiz ederken __all__ ifadesini kullanmaktan kaçının, böylece belgeleme yapabilirsiniz.
• Yeni docstring'lerin kalıtımını kontrol etmek gerçekten değerlidir. Eğer yeni docstring'i düzeltmek için ayar yapılmışsa, açıkça belirtmediğiniz takdirde, annelerden aktarılır.
• Yeni "size kalıtımınızı anlatın" seçeneğinin sunulması şartıyla yayınlandı.

1King casino girişi – Kurmak¶

Otomatik belge oluşturma işlemi tamamlandığında ve harika bir belge dizisi işlediğinizde üretilir. Bu nedenle, yeni belge dizilerinin genetiğini kontrol etmekte fayda var. Yeni belge 1King casino girişi dizisini düzeltmek için ayarlarsanız, açıkça ayarlamazsanız, aslında annelerden aktarılır. Belgede analiz edilmeyen takma adların bir biçimi olarak kalır. Aşırı yüklenmiş işlevler veya ipuçları, açıklamada kullanılan tür ipuçlarına sahip olmayacaktır, çünkü çok sayıda ayrıntı nedeniyle tüm olası aşırı yüklemeleri doğru bir şekilde göstermek pratik değildir.

Liman işçisi¶

Sphinx'in kök dizinine, yani "neden dizini"ne, Sphinx'in kullandığı varsayılan işaretleme yapısı olan reStructuredText'e ulaşabilirsiniz. Bu dosyanın amacı, Sphinx'in ne olduğunu ve nasıl kullanılabileceğini size anında göstermektir.

• Sphinx-contriborganization ile ilgili olarak kullanıcılar tarafından paylaşılan çok sayıda eklenti bulunmaktadır.
• Marka grubundaki özel kişilere ait otomatik kayıtlar oluşturun, bunlar 'dunder' etiketleri olarak da bilinir. Bu, çift vurgu içeren tüm kapalı isimleri içerir, örneğin:
• Ayrıca, bulunabildiği takdirde, yepyeni eşleşen envvar yönergesine iyi bir bağlantı oluşturur.

Nesneler arasında çapraz referans verme¶

Yeni dosya adı genellikle en yeni kaynak dosyasının bulunduğu listeye göre belirlenir, ancak eğer dosya adı / ile başlıyorsa, en üst kaynak dizinine göre belirlenir. Belirtilen dosyaya göre ilişki; yeni belge adı göreceli veya mutlak bir yol olabilir ve bu her zaman duruma duyarlıdır, hatta ekranınız için bile. Yalnızca yeni dosya adı miras alma seçeneği dikkate alındığında yayınlanır. Temel bilgiler, Sphinx'in performans için ayarladığı şeyleri değiştirmek üzere işleyicinizin değiştirebileceği türlerin bir listesidir. Sıfır satır eşleşmesi durumunda, yeni sonuçlanan belge dizisi boştur, bu nedenle keepempty doğru olmadığı sürece hiçbir değişiklik yapılamaz.

Bir web sitesi, ona ait nesne türlerinin bir koleksiyonudur; bu koleksiyon, oluşturmak için gerekli işaretlemeyi içerir ve siz de bu öğelere referans veren açıklamalar bulacaksınız. Sphinx'in temel amaçlarından biri, her alan adındaki öğelerden (çok genel anlamda) basit belgeler oluşturmaktır. Ancak, sphinx-quickstart yazılımı harika bir Makefile oluşturur ve siz de hayatı sizin için kolaylaştıran bir make.bat dosyası oluşturabilirsiniz.

Anahatlar, deneyim işleyicisinin Sphinx'in verimlilik için ayarladıklarını değiştirmek üzere özelleştirebileceği bir dize listesidir – kendi hazır belge dizenizin yeni hatları. Bu, kaynak parolanız yorum türlerini keşfedemiyorsa, örneğin yalnızca ek açıklama türlerini harcıyorsa veya hiçbir ipucu türünü keşfetmiyorsa gerçekten engellenir. Eksik ek açıklama türlerini geliştirmek için kaynak koduna yorumlar, Doğru olması durumunda.

Yeni bileşeni analiz ederken __all__ kullanmayın, böylece dosya oluşturabilirsiniz. Bunun yerine, autodoc, tanımdan sonra yeni bir satırda bir docstring'i de anlayabilir. reStructuredText yerine NumPy veya Google düzeninde docstring'ler istiyorsanız, napoleon genişletmesini etkinleştirebilirsiniz. napoleon, autodoc tekniklerinden önce docstring'leri doğru reStructuredText'e dönüştürmek için iyi bir önişlemci kullanır. Süreç boyunca bir kılavuz olarak yardımcı olacak rastgele yemek tarifleri oluşturmak için kurgusal bir yazılım kütüphanesi kullanabilirsiniz, böylece bunları güvenli bir şekilde kaydedebilirsiniz. Genellikle planın adı python3-sphinx, python-sphinx veya sphinx'tir. Daha fazla bilgi edinmek için thesphinx-build boy sayfasına bakın.