pydoctor - Online sa Cloud

PROGRAMA:

NAME

pydoctor - generator ng dokumentasyon ng API para sa Python

SINOPSIS

pydoctor [pagpipilian]

DESCRIPTION

Ang Pydoctor ay isang generator ng dokumentasyon ng API na pangunahing gumagana sa pamamagitan ng static na pagsusuri.

Ito ay isinulat lalo na upang palitan ang epydoc para sa mga layunin ng Twisted na proyekto bilang
Nahihirapan ang epydoc sa zope.interface, ngunit maaaring gamitin para sa non-Zope Python code bilang
mabuti.

Opsyon

-h, - Tumulong
ipakita ang mensahe ng tulong na ito at lumabas

-c CONFIGFILE, --config=CONFIGFILE
Gumamit ng config mula sa file na ito (anumang command lineoptions ay na-override ang mga setting mula sa
file)

-p INPUTPICKLE, --input-pickle=INPUTPICKLE
I-load ang system mula sa pickle file na ito (default: wala, isang blangkong system ang nalikha).

-o OUTPUTPICLE, --output-pickle=OUTPUTPICLE
I-save ang system sa pickle file na ito (default: wala, ang system ay hindi nai-save ng
default).

--dagdag na sistema=Sys:URLPREFIX
Maghanap ng mga bagay sa system na ito upang. Ang mga link sa mga bagay na ito ay magkakaroon ng URLPREFIX
inihanda sa kanila.

--system-class=SYSTEMCLASS
Isang tuldok na pangalan ng klase na gagamitin para gumawa ng system.

--Pangalan ng proyekto=PANGALAN NG PROYEKTO
Ang pangalan ng proyekto, ay lilitaw sa html.

--url ng proyekto=PROYEKTO
Ang url ng proyekto, ay lilitaw sa html kung ibinigay.

--project-base-dir=PROJECTBASEDIRECTORY
Ganap na landas sa base na direktoryo ng proyekto. Ang mga link ng pinagmulan ay kalkulahin
batay sa halagang ito.

--pagsubok
Huwag magreklamo kung ang pagtakbo ay walang epekto.

--pdb Tulad ng py.test's --pdb.

--make-html
Gumawa ng html output.

--server
Ihatid ang HTML sa isang lokal na server.

--server-port=SERVER_PORT
Ang daungan para sa --server gamitin.

--lokal-lamang
Itali ang server sa localhost lamang.

--nakaharap sa landas=FACING_PATH
Mag-set up ng VHostMonster, kasama ang lahat ng pagkalito na nagpapahiwatig.

--edit Kapag naghahatid ng HTML, payagan ang pag-edit.

--walang-check
Kapag naghahatid ng HTML at pinapayagan ang pag-edit, huwag munang suriin ang lahat ng docstring.

--add-package=PACKAGEDIR
Magdagdag ng package sa system. Maaaring ulitin upang magdagdag ng higit sa isang pakete.

--add-module=MODYUL
Magdagdag ng module sa system. Maaaring ulitin.

--prepend-package=PREPENDEDPACKAGE
Magpanggap na ang lahat ng mga pakete ay nasa loob ng isang ito. Maaaring gamitin upang idokumento ang bahagi ng a
Pakete.

--resolve-aliases
Ito ay nag-a-update ng mga sanggunian sa mga klase na na-import mula sa isang module kung saan sila napunta
na-import sa mga sanggunian kung saan tinukoy ang mga ito.

--paikliin-espesyal na kaso=PAG-ABREVMAPPING
Ito ay isang listahan na pinaghihiwalay ng kuwit ng key=value pairs. Kung saan ang anumang susi ay tumutugma sa a
pangalan at halaga ng module ang nais na pagdadaglat. Ito ay maaaring gamitin upang malutas
sumasalungat sa abbreviation kung saan mayroon kang dalawa o higit pang mga module na nagsisimula sa
parehong sulat. Halimbawa: twistedcaldav=tcd.

--docformat=DOCFORMAT
Aling mga docstring ng format na sinusuportahan ng epydoc ang ipinapalagay na nasa.

--html-subject=HTMLSUBJECTS
Ang buongName ng object para bumuo ng mga API docs para sa (default: everything).

--html-summary-pages
Bumuo lamang ng mga pahina ng buod.

--html-write-function-pages
Gumawa ng mga indibidwal na HTML file para sa bawat function at pamamaraan. Hindi sila naka-link sa in
anumang pydoctorgenerated HTML, ngunit maaari silang maging kapaki-pakinabang para sa pag-link ng third-party.

--html-output=HTMLOUTPUT
Direktoryo upang i-save ang mga HTML na file sa (default na 'apidocs')

--html-manunulat=HTMLWRITER
Dotted na pangalan ng html writer class na gagamitin (default na 'pydoctor.nevowhtml.NevowWriter',
nangangailangan ng Divmod Nevow na mai-install).

--html-viewsource-base=HTMLSOURCEBASE
Ito dapat ang landas patungo sa trac browser para sa tuktok ng svn checkout na tayo
pagdodokumento ng bahagi ng.

--html-use-sorttable
Gamitin ang sorttable JS library para gumawa ng mga talahanayan ng mga nilalaman ng package, module at klase
naaayos

--html-use-splitlinks
Bumuo ng (hindi nakakagambala) JavaScript upang payagan ang mga pamamaraan ng klase na maipakita sa isa
table sa bawat base class o sa isang malaking table.

--html-shorten-lists
Bumuo ng (hindi nakakagambala) JavaScript upang itago ang ilan sa mga entry sa mahabang listahan ng
hal mga subclass.

--livecheck
Mag-import at suriin din ang mga module. Hindi gumagana ang XXX ngayon

-v, --verbose
Maging mas maingay. Maaaring ulitin para sa mas maraming ingay.

-q, --tahimik
Mas tahimik.

--auto Automagic mode: pag-aralan ang lahat ng mga module at package sa kasalukuyang gumaganang direktoryo
at magpatakbo ng isang lokal na server na nagbibigay-daan sa pagsusuri at pag-edit ng mga docstring.

--verbose-about=yugto
Maging maingay sa isang partikular na yugto ng henerasyon.

Gumamit ng pydoctor online gamit ang mga serbisyo ng onworks.net