Bu, Ubuntu Online, Fedora Online, Windows çevrimiçi emülatörü veya MAC OS çevrimiçi emülatörü gibi birden fazla ücretsiz çevrimiçi iş istasyonumuzdan birini kullanarak OnWorks ücretsiz barındırma sağlayıcısında çalıştırılabilen komut pydoctor'dur.
Program:
ADI
pydoctor - Python için API dokümantasyon oluşturucu
SİNOPSİS
doktor [seçenekleri]
TANIM
Pydoctor, öncelikle statik analizle çalışan bir API dokümantasyon üreticisidir.
Öncelikle Twisted projesinin amaçları doğrultusunda epydoc'u değiştirmek için yazılmıştır.
epydoc, zope.interface ile ilgili zorluklara sahiptir, ancak Zope olmayan Python kodu için şu şekilde kullanılabilir:
iyi.
SEÇENEKLER
-h, --yardım et
bu yardım mesajını göster ve çık
-c YAPILANDIRMA DOSYASI, --yapılandırma=YAPILANDIRMA DOSYASI
Bu dosyadan config kullanın (herhangi bir komut satırı seçeneği,
dosyası).
-p GİRİŞ PICKLE, --input-turşu=GİRİŞ PICKLE
Sistemi bu turşu dosyasından yükleyin (varsayılan: yok, boş bir sistem oluşturulur).
-o ÇIKIŞ ÇIKIŞI, --çıktı-turşu=ÇIKIŞ ÇIKIŞI
Sistemi bu turşu dosyasına kaydedin (varsayılan: yok, sistem tarafından kaydedilmez.
varsayılan).
--ekstra sistem=SYS:URLPÖNEK
Bu sistemdeki nesneleri arayın. Bu nesnelere bağlantılarda URLPREFIX olacaktır
onlara önceden hazırlanmıştı.
--system-sınıfı=SİSTEM SINIFI
Bir sistem oluşturmak için kullanılacak sınıfın noktalı adı.
--proje Adı=PROJE ADI
Proje adı html'de görünür.
--Proje URLsi=PROJE URLSİ
Proje url'si, verilmişse html'de görünür.
--proje-tabanı-dir=PROJE TABAN DİZİNİ
Projenin temel dizinine giden mutlak yol. Kaynak bağlantılar hesaplanacak
bu değere dayanmaktadır.
--test yapmak
Koşunun herhangi bir etkisi yoksa şikayet etmeyin.
--pdb py.test'inki gibi --pdb.
--make-html
Html çıktısı üretin.
--sunucu
HTML'yi yerel bir sunucuda sunun.
--Sunucu portu=SUNUCU PORTU
için liman --sunucu kullanmak.
--Sadece yerel
Sunucuyu yalnızca localhost'a bağlayın.
--karşı karşıya-yol=FACING_PATH
Tüm karışıklığı içeren bir VHostMonster kurun.
--Düzenle HTML sunarken düzenlemeye izin verin.
--kontrol yok
HTML sunarken ve düzenlemeye izin verirken, önce tüm belge dizilerini kontrol etmeyin.
--add-paket=PAKET DİR
Sisteme bir paket ekleyin. Birden fazla paket eklemek için tekrar edilebilir.
--add-modülü=MODÜL
Sisteme bir modül ekleyin. Tekrar edilebilir.
--prepend-paket=BAŞLANGIÇ PAKET
Tüm paketlerin bunun içinde olduğunu varsayın. Bir bölümünü belgelemek için kullanılabilir
paketi.
--çözme-takma adlar
Bu, içinde bulundukları bir modülden içe aktarılan sınıflara referansları günceller.
tanımlandıkları yere referanslara aktarılır.
--kısaltma-özel durum=KISALTMA
Bu, anahtar=değer çiftlerinin virgülle ayrılmış listesidir. Herhangi bir anahtarın bir
modül adı ve değeri istenen kısaltmadır. Bu çözmek için kullanılabilir
ile başlayan iki veya daha fazla modülünüz olduğunda kısaltma ile çakışıyor
aynı mektup. Örnek: twistedcaldav=tcd.
--doküman biçimi=DOKFORMAT
Hangi epydoc-desteklenen biçim belge dizgilerinin içinde olduğu varsayılır.
--html-konu=HTMLKONULAR
API belgeleri oluşturulacak nesnenin tamAdı (varsayılan: her şey).
--html-özet-sayfaları
Yalnızca özet sayfalarını oluşturun.
--html-yazma-işlev-sayfaları
Her işlev ve yöntem için ayrı HTML dosyaları oluşturun. ile bağlantılı değiller
herhangi bir pydoctor tarafından oluşturulan HTML'dir, ancak üçüncü taraf bağlantıları için yararlı olabilirler.
--html-çıktı=HTMLÇIKTI
HTML dosyalarının kaydedileceği dizin (varsayılan 'apidocs')
--html-yazar=HTML YAZICI
Kullanılacak html yazıcı sınıfının noktalı adı (varsayılan 'pydoctor.nevowhtml.NevowWriter',
Divmod Nevow'un yüklenmesini gerektirir).
--html-kaynak-tabanını görüntüle=HTML KAYNAK TABANI
Bu, olduğumuz svn ödemesinin en üst kısmı için trac tarayıcısının yolu olmalıdır.
kısmını belgeliyor.
--html-use-sıralanabilir
Paket, modül ve sınıf içeriği tabloları oluşturmak için sıralanabilir JS kitaplığını kullanın
sıralanabilir
--html-kullanım-bölünmüş bağlantılar
Sınıf yöntemlerinin bir arada gösterilmesine izin vermek için (göze batmayan) JavaScript oluşturun
temel sınıf başına veya büyük bir masada tablo.
--html-kısaltılmış-listeler
Uzun listelerdeki bazı girdileri gizlemek için (göze batmayan) JavaScript oluşturun.
örneğin alt sınıflar.
--canlı kontrol
Modülleri de içe aktarın ve inceleyin. XXX şu anda çalışmıyor
-v, --ayrıntılı
Daha gürültülü ol. Daha fazla gürültü için tekrar edilebilir.
-q, --sessizlik
Daha sessiz ol.
--Oto Otomatik mod: mevcut çalışma dizinindeki tüm modülleri ve paketleri analiz edin
ve belge dizilerinin incelenmesine ve düzenlenmesine izin veren yerel bir sunucu çalıştırın.
--ayrıntılı-hakkında=sahne
Üretimin belirli bir aşamasında daha gürültülü olun.
onworks.net hizmetlerini kullanarak pydoctor'u çevrimiçi kullanın
