python-sphinx

9ısı

1cevap

Python: Sfenks: Sfenks belgelerinde tüm sınıfları, yöntemleri ve işlevleri otomatik olarak nasıl eklenir?

Olası Çoğalt: Sphinx — combining automodule and autoclass Ben sfenks kullanarak birkaç bin sınıfları içeren bir proje için bir html belgeleri oluşturmak için deneyin ve AutoDoc eklenti bulunmaktadır.

16ısı

3cevap

Sphinx kullanarak istisna nasıl belgelenir

Sphinx kullanarak istisnaların nasıl belgeleneceğini anlayamıyorum. "; Beklenmedik GİRİNTİSİZ Saha liste boş hat olmadan biter." def some_funct(): """ :raises: ExceptionType: Some multi-line

7ısı

3cevap

Alma Github tek dosya bir eklenti Sfenks dokümantasyon sistemi için inşa planlıyorum

katkıda bulunanlar eklenti hangi isim ve dokümantasyon sayfasına katkıda bulunmuş kişilerin Github profil bağlantılarını gösterir. Github bu özelliğe sahip dahili o Github API üzerinden dosya katkıda

7ısı

1cevap

python-sphinx

tarafından oluşturulan belgelerde dinamik içerik dahil olmak üzere Projem için belgeler oluşturmak ve belgeleri ürünün yükleme işleminin bir parçası olarak oluşturmak için sphinx kullanıyorum. Ana mak

8ısı

1cevap

Python-Sfenks'te meta verileri nasıl eklenir (belge aracı)

Sphinx tarafından oluşturulan web sayfalarında bazı meta veriler (yani anahtar kelimeler, açıklama, yazar) eklemek istiyorum. Ben Sfenks'in belgelerinde :fieldname: Field content buldum ama nasıl ku

24ısı

3cevap

UYARI: belge dahil dosyanın

Ben uyarıyı alıyorum herhangi toctree dahil değildir: bunlar açık bir şekilde dahil oldum çünkü doküman içinde yer dosyalar için WARNING: document isn't included in any toctree . olduğu gibi, 0020-b

8ısı

1cevap

Sfenks bir görüntüye veya bir bağlantıya bağlantı ekleyerek

Sphinx'te oldukça basit bir şey deniyorum. Bazı resimlerim var, ama onları oldukça küçük tutmayı tercih ediyorum ve kullanıcının daha büyük resmi elde etmek için onlara tıklamasına izin vermek istiyor

10ısı

2cevap

Sfenksin bir URL'yi köprüyü yapmasını nasıl önleyebilirim?

Dokümanlarımda bazen "çöp" URL'lerini örnek olarak kullanıyorum ve bunların hiçbir yerde köprüler olmasını istemiyorum. Bu URL'leri köprüler haline getirmek için herhangi bir sözdizimi var mı?

5ısı

2cevap

Sphinx belgelerinden tek bir .pot dosyası oluşturmak mümkün mü?

Büyük bir projenin belgelenmesi i18n/l10n'nin görevini üstleniyorum. Dokümantasyon, basic support for i18n numaralı rafa sahip olan Sphinx ile yapılır. Benim sorunum this other question'a benziyor: ya

6ısı

3cevap

piton-sfenks: Bir prensibi nasıl gösterilebilir?</p> <pre><code>.. code-block:: ruby. ${your ruby code goes here} </code></pre> <p>: linux komut kodunu göstermek için nasıl

sfenks kullanarak pasajlarını, ben gibi bir şey alarak piton kod parçacığı veya yakut Kod parçası bir parça gösterebilir biliyorum linux komutlarının snippet'i veya herhangi bir dille ilgili olmayan b