python-sphinx

8ısı

2cevap

Python/Sphinx belge nesnesi özniteliklerini __init__ içinde yalnızca nasıl ilan edebilirim? nesnesi, yalnızca beyan edildiği nitelikleri ile

Python sınıfları şöyle, yapıcı çalışan bir parçası olarak: class Foo(object): def __init__(self, base): self.basepath = base temp = [] for run in os.listdir(self.basepath):

112ısı

4cevap

Sphinx autodoc yeterince otomatik değil

Python'da 5.000'den fazla projeyi belgelemek için Sphinx'i kullanmaya çalışıyorum. Yaklaşık 7 temel modüle sahiptir. Gibi bildiğim kadarıyla, AutoDoc kullanmak için Projemde her dosya için böyle kod y

8ısı

1cevap

Sphinx'te nasıl büyük bir yük olmadan linkable bir "terminoloji" bölümü oluşturabilirim?

Bu terminoloji bölümündeki terimleri her kullanışımda, tanıma işaret eden bir bağlantı oluşturulduğu şekilde kullandığım terimlerin tanımları ile bir "terminoloji" bölümü oluşturmak istiyorum. Şu , ay

5ısı

2cevap

Sfenks - otomatik Trac biletleri başvurular ve changesets

Sphinx mi oluşturmak, otomatik Trac içinde biletin/changesets karşılık gelen etmek #112 veya r1023 gibi Bağ metnine yol var? eg için : #112 -> http://mytracsite/tickets/112 r1023 -> http://mytracsite

11ısı

3cevap

Sfenks'te, parametreleri bildirmekle birlikte belgelemenin bir yolu var mı?

D.R.Y. uygulamak için parametreyi bildirdiğim her satırın (gerektiği gibi) aynı satırda belgelenmesini tercih ederim. Bu gibi bir kod varsa: def foo( flab_nickers, # a series of under garments to

10ısı

3cevap

Python'un web sitesi çevrimiçi belgelerini nasıl oluşturur?

Sphinx 0.6.5 kullanılarak oluşturuldu. Python'ın belgelerine reStructuredText kullanır biliyorum ama http://docs.python.org/whatsnew/2.6.html ve http://docs.python.org/tutorial/index.html gibi farklı

6ısı

3cevap

Sphinx (belge aracı): çıkışta sekme genişliğini ayarlama

Sekme genişliğini, Pygments tarafından vurgulanan Sfenks kod parçacıklarının HTML çıktısında nasıl belirlersiniz? Varsayılan olarak, can sıkıcı bir 8'dir, ancak 4 istiyorum. Bu ayar hakkında Sphinx co

10ısı

1cevap

Sfenks belgelerime PDF eklemenin en iyi yolu nedir?

Elimde bir paket için Sphinx belgelerinde bir örnek için derinlemesine bir açıklama içeren bir PDF'im var. PDF'yi projeme kolayca dahil etmenin bir yolu var mı (Dokümanları hazırladığımda kopyalamam g

5ısı

2cevap

Sphinx - Python modülleri, sınıfları ve işlevleri Dökümantasyon

Küçük projemi, yakın zamanda tanımaya çalışan bir sphinx aracılığıyla belgelemeye çalışıyorum. Bazı öğreticiler ve sfenks belgeleri okudum ama yapamadım. Kurulum ve yapılandırmalar tamam! Sfenks kulla

5ısı

1cevap

Sfenks: çapraz referans öğesi

endeksli nasıl reStructuredText belgesinin içinde bir dizinli öğeyi-reference geçer ki? Ben nasıl Örneğin , çapraz-referans SectionB: .. index:: pair: SectionA; SectionB SectionB -------- Se