epydocgui - Bulutta Çevrimiçi

Program:

ADI

epydocgui - epydoc için grafik arayüz

SİNOPSİS

epidocgui [proje.prj | modüller...]

epidoc -h

epidoc -V

TANIM

epidocgui Python için API belgeleri oluşturan epydoc için bir grafik arabirimdir
dokümantasyonlarına göre modüller ve paketler. adlı hafif bir biçimlendirme dili
metin belge dizilerini biçimlendirmek ve belirli alanlar hakkında bilgi eklemek için kullanılabilir,
parametreler ve örnek değişkenler gibi.

Tarafından üretilen API belgeleri epidocgui bir dizi HTML dosyasından oluşur. XNUMX
genel ve özel belgeler için alt dizinler oluşturulur. Her birinin içinde
alt dizinler, her sınıf ve modül kendi dosyasında belgelenir. Bir dizin dosyası, bir
ağaçlar dosyası ve bir yardım dosyası da oluşturulur. seçerseniz Çerçeve seçeneği, ardından bir
çerçeve tabanlı içindekiler tablosu da üretilir.

SEÇENEKLER

proje.prj
İle kaydedilen bir proje dosyasının adı epidocgui. Proje dosyaları bir
ilgili modüllerin listesi ve bu modülü oluşturmak için kullanılması gereken seçenekler
bu modüller için belgeler.

modüller...
Belgelenmesi gereken modüllerin listesi. Modüller kullanılarak belirtilebilir
modül adları (örneğin os.yol), dosya adları (örneğin epydoc/epytext.py) veya dizin
isimler (örneğin epidoc/). Dizin adları paketleri belirtir ve
tüm alt modülleri ve alt paketleri içerir.

-H, --Yardım, --kullanım, -?
Bir kullanım mesajı görüntüleyin.

-V, --versiyon
Epydoc'un sürümünü yazdırın.

HTML DOSYALAR

Tarafından üretilen API belgeleri epidoc aşağıdaki dosyalardan oluşur:

index.html
Belgeler için standart giriş noktası. Normalde, index.html bir
üç çerçeveyi tanımlayan çerçeve indeks dosyası: ekranın sol tarafında iki çerçeve
tarayıcı bir içindekiler tablosu ve sağ tarafta ana çerçeve içerir
pencerenin belge sayfaları içerir. Ama eğer --çerçevesiz seçenektir
kullanılmış, daha sonra index.html kullanıcıyı projenin en üst sayfasına yönlendirecektir.

m-modül.html
Bir modül için API belgeleri. modül tam noktalı adıdır
modül, örneğin sys or epidoc.epytext.

c sınıfı.html
Bir sınıf, istisna veya tür için API belgeleri. c tam
sınıfın noktalı adı, örneğin epydoc.epytext.Token or dizi.ArrayType.

ağaçlar.html
Modül ve sınıf hiyerarşileri.

indeksler.html
Terim ve tanımlayıcı dizinler.

yardım.html
Proje için yardım sayfası. Bu sayfada,
epydoc tarafından üretilen web sayfası.

toc.html
Üst düzey içindekiler sayfası. Bu sayfa sol üstte görüntülenir
çerçeve ve bağlantılar sağlar toc-her şey.html ve toc-m-modül. Html
dosyaları. toc.html ise oluşturulmaz --çerçevesiz seçeneği kullanılır.

toc-her şey.html
Tüm proje için içindekiler tablosu. Bu sayfa şurada görüntülenir:
sol alt çerçeve ve her sınıfa, türe, istisnaya, işleve bağlantılar sağlar,
ve proje tarafından tanımlanan değişken. toc-her şey.html eğer oluşturulmaz
the --çerçevesiz seçeneği kullanılır.

toc-m-modül. Html
Bir modülün içindekiler tablosu. Bu sayfa sol altta görüntülenir
çerçeve ve her sınıfa, türe, istisnaya, işleve ve
modül tarafından tanımlanan değişken. modül tam noktalı adıdır
modül, örneğin sys or epidoc.epytext. toc-m-modül. Html eğer oluşturulmaz
the --çerçevesiz seçeneği kullanılır.

epidoc.css
Tüm HTML sayfalarını görüntülemek için kullanılan CSS stil sayfası.

Varsayılan olarak, epidoc çıktı dizininde iki alt dizin oluşturur: halka açık ve özel.
Her dizin, yukarıda belirtilen tüm dosyaları içerir. Ama eğer --no-özel seçenek
kullanılır, daha sonra hiçbir alt dizin oluşturulmaz ve genel belgeler yazılır
doğrudan çıktı dizinine. beş kategoriye ayrılmıştır: içe aktarma hataları; metin
hatalar; metin uyarıları; alan uyarıları; ve muayene hataları. ne zaman epidoc
bir hatayla karşılaşırsa, hatayı açıklayan bir uyarı mesajı verir ve
dokümantasyon oluşturmaya devam edin.

İçe aktarma hataları, epydoc'un bir modülü içe aktaramadığını gösterir. Hataları içe aktarma genellikle
epydoc'un söz konusu modül için belgeler oluşturmasını önleyin. epidoc olabilir
aşağıdaki içe aktarma hatalarını oluşturun:

Kötü modül isim modül
Epydoc içe aktarmayı denedi modül, fakat modül Python için geçerli bir isim değil
modülü.

Olabilir değil bulmak a UID için Bağlantı hedefi
Epydoc, bir satır içi bağlantı yapısı tarafından atıfta bulunulan nesneyi bulamadı
({...}). Bu genellikle bağlantıdaki bir yazım hatasından kaynaklanır.

Olabilir değil ithalat modül
Epydoc içe aktarmayı denedi modül, ama başarısız oldu. Bu genellikle şu durumlarda oluşur:
modül bir istisna oluşturur.

dosya yok değil mevcut
Epydoc, içinde bulunan modülü içe aktarmaya çalıştı. dosya, fakat dosya değil
var olmak.

Epytext hatalarına, geçersiz işaretleme içeren epytext belge dizileri neden olur. ne zaman bir
epytext hatası algılanırsa, söz konusu doküman dizisi düz metin doküman dizisi olarak değerlendirilir.
Epydoc, aşağıdaki metin metni hatalarını oluşturabilir:

Kötü Link hedef.
Bir satır içi bağlantı yapısı için belirtilen hedef ({...}) iyi değil-
oluşturulan. Bağlantı hedefleri geçerli python tanımlayıcıları olmalıdır.

Kötü Linkler hedef.
Bir satır içi uri yapısı için belirtilen hedef ({...}) iyi biçimli değil.
Bu genellikle, satır içi işaretleme URI hedefinin içine yerleştirilmişse oluşur.

Alanlar şart be at the üst seviye.
alanların listesi (@param, vb.) başka bir blok yapısı tarafından kapsanır
(liste veya bölüm gibi).

Alanlar şart be the son elemanları.
alanların listesi (@param, vb.) bir belge dizisinin sonunda değil.

Başlıklar şart meydana at üst seviye.
Başlık, başka bir blok yapısında (liste gibi) bulunur.

uygunsuz belge testi blok girinti.
En doctest bloğu, ilk istem satırının girintisini geçer.

uygunsuz başlık girinti.
Bir bölümün başlığı, bölümdeki paragraflarla sola dayalı değildir.
içeren bölümdür.

uygunsuz paragraf girinti.
Bir blok içindeki paragraflar sola hizalı değildir. Bu hata çoğu zaman
düz metin belge dizileri epytext kullanılarak ayrıştırıldığında oluşturulur.

Geçersiz kaçış.
Satır içi kaçış yapısında bilinmeyen bir kaçış dizisi kullanıldı
({...}).

Listeler şart be girintili.
Paragrafın hemen ardından gelen girintisiz satır, liste madde işaretiyle başlar.
Epydoc, yeni bir liste öğesi mi başlatmak istediğinizden veya bir
madde işareti gibi görünen bir kelime eklemek için paragraf. Eğer niyet ettiyseniz
önce, sonra listeyi girintileyin. İkincisini amaçladıysanız, o zaman değiştirin
paragrafın sözcük kaydırması veya sözcüğün ilk karakterinden kaçınılması
mermiye benziyor.

Dengesiz '{'.
Doküman dizisi dengesiz parantezler içeriyor. Epytext, tüm parantezlerin
dengeli olmalıdır. Tek bir dengesiz ayraç eklemek için kaçış
E{lb} (sol ayraç) ve E{rb} (sağ ayraç) dizileri.

Dengesiz '}'.
Doküman dizisi dengesiz parantezler içeriyor. Epytext, tüm parantezlerin
dengeli olmalıdır. Tek bir dengesiz ayraç eklemek için kaçış
E{lb} (sol ayraç) ve E{rb} (sağ ayraç) dizileri.

Bilinmiyor inline işaretleme etiketi.
Satır içi biçimlendirme yapısında bilinmeyen bir etiket kullanıldı ( x{...} ).

Yanlış altını çizmek karakter için başlığı.
Bu bölüm başlığı için kullanılan alt çizgi karakteri bir
uygun bölüm seviyesi. Altını çizmek için "=" karakteri kullanılmalıdır
bölümler; "-" alt bölümler için; ve alt bölümler için "~".

Epitext uyarılarına, şüpheli veya şüpheli içeren epitext doküman dizileri neden olur.
işaretleme. Epitext uyarıları değil söz konusu belgenin ayrıştırılmasını önleyin.
Epydoc, aşağıdaki metin metni uyarılarını oluşturabilir:

Mümkün hatalı biçimlendirilmiş alan öğe.
Epytext, alan öğesi gibi görünen ancak doğru olmayan bir satır algıladı
biçimlendirilmiş. Bu genellikle, sondaki iki nokta üst üste (":") dahil edilmediğinde ortaya çıkar.
alan etiketinde.

Mümkün başlık yazım hatası.
Epytext, başlığa benzeyen bir çift satır algıladı, ancak
altı çizili karakterler başlıktaki karakter sayısıyla eşleşmiyor.
olması için bu iki satırdaki karakter sayısı tam olarak eşleşmelidir.
bir başlık olarak kabul edilir.

Alan uyarıları, geçersiz alanlar içeren epitext belge dizilerinden kaynaklanır. İçerikler
geçersiz alan genellikle yoksayılır. Epydoc aşağıdaki alanı oluşturabilir
uyarılar:

@param için bilinmeyen parametre param.
Bir parametrenin türünü belirtmek için bir @param alanı kullanıldı.
fonksiyonun imzasında bulunur. Bu genellikle bir yazım hatasından kaynaklanır
parametre adı.

etiket yaptı değil beklemek an argüman.
alan etiketi etiket bir argümanla kullanıldı, ancak bir tane almıyor.

etiket beklenen an argüman.
alan etiketi etiket argüman olmadan kullanıldı, ancak bir tane gerektiriyor.

@tip için bilinmeyen parametre param.
Dahil edilmeyen bir parametrenin türünü belirtmek için bir @type alanı kullanıldı
işlevin imzasında. Bu genellikle bir yazım hatasından kaynaklanır.
Parametre adı.

@tip için bilinmeyen değişken var.
Bir değişkenin türünü belirtmek için bir @type alanı kullanıldı, ancak başka bir alan kullanılmadı.
Değişken hakkında bilgi bilinir. Bu genellikle bir yazım hatasından kaynaklanır
değişken adı.

Bilinmiyor alan etiket etiket.
Bir doküman dizisi, bilinmeyen etikete sahip bir alan içeriyor etiket.

yeniden tanımlama of alan.
Birden çok alan etiketi, değerini tanımlar alan aynı belgede, ancak alan
sadece tek bir değer alabilir.

epydoc incelemeye çalışırken sorunlarla karşılaşırsa inceleme hataları oluşturulur
belgelenmiş bir nesnenin özellikleri. Denetim hatalarının çoğu epydoc'u engellemez
söz konusu nesneyi belgelemekten. Epydoc aşağıdaki incelemeyi oluşturabilir
hataları:

The parametreler of yöntem do değil maç temel yöntem.
Belgelenmemiş yöntemin parametreleri yöntem parametrelerle eşleşmeyin
temel sınıf yönteminin temel yöntem geçersiz kılmasıdır. Sonuç olarak, yöntem
belgeleri devralmaz temel yöntem. Eğer fark varsa
parametreler kasıtlıysa, bir uyarı ekleyerek uyarıyı ortadan kaldırabilirsiniz.
(muhtemelen boş) docstring için yöntem.

belge haritası yapamam eklemek a tip
Epydoc, türü bilinmeyen bir nesneyi belgelemeye çalıştı. Bu hata
genellikle içe aktarmayı yöneten paketler ve modüller tarafından oluşturulur
mekanizma, öyle ki bir modülü içe aktarmak başka bir tür nesne üretir.

UID fikir ayrılığı saptanmış: uid
epydoc tarafından iki farklı nesneye aynı benzersiz tanımlayıcı atanmıştır. Bu
epydoc'un bir nesnenin belgelerini
aynı benzersiz tanımlayıcıya atanan başka bir nesnenin belgeleri.
Ancak, bu genellikle yalnızca iki nesne aynı olduğunda sorunlara neden olur.
benzersiz tanımlayıcılar hem modüller hem de sınıflardır; bu durumda API
bir nesne için dokümantasyon sayfası, API dokümantasyon sayfasının üzerine yazacaktır.
diğer nesne.

nesne belirir in çoklu builtin modüller
Yerleşik nesneyi hangi modülün tanımladığını belirlemeye çalışırken nesne,
epydoc birden fazla adayla karşılaştı ve hangisi olduğuna karar veremedi
aday haklı. Bu durumda, epydoc keyfi olarak ilkini seçer.
bulduğu aday.

nesne belirir in çoklu .py modüller
Yerleşik nesneyi hangi modülün tanımladığını belirlemeye çalışırken nesne,
epydoc birden fazla adayla karşılaştı ve hangisi olduğuna karar veremedi
aday haklı. Bu durumda, epydoc keyfi olarak ilkini seçer.
bulduğu aday.

nesne belirir in çoklu .yani modüller
Yerleşik nesneyi hangi modülün tanımladığını belirlemeye çalışırken nesne,
epydoc birden fazla adayla karşılaştı ve hangisi olduğuna karar veremedi
aday haklı. Bu durumda, epydoc keyfi olarak ilkini seçer.
bulduğu aday.

Olabilir değil bulmak a modül için nesne
Epydoc hangi modülün tanımladığını belirleyemedi nesne. Eğer nesne bir
işlevi, o zaman bu, epydoc'un herhangi bir belge oluşturmasını önleyecektir.
nesne, çünkü belgeleri hangi sayfaya koyacağını bilmiyor.
Aksi takdirde, bu, belgelerin nesne bir bağlantı eklemekten
içeren modülüne.

onworks.net hizmetlerini kullanarak epydocgui'yi çevrimiçi kullanın