pydoctor - ອອນລາຍໃນຄລາວ

ໂຄງການ:

NAME

pydoctor - ການສ້າງເອກະສານ API ສໍາລັບ Python

ສະຫຼຸບສັງລວມ

ທ່ານໝໍ [ທາງເລືອກໃນການ]

ລາຍລະອຽດ

Pydoctor ແມ່ນເຄື່ອງສ້າງເອກະສານ API ທີ່ເຮັດວຽກຕົ້ນຕໍໂດຍການວິເຄາະສະຖິດ.

ມັນໄດ້ຖືກລາຍລັກອັກສອນຕົ້ນຕໍເພື່ອທົດແທນ epydoc ສໍາລັບຈຸດປະສົງຂອງໂຄງການ Twisted ເປັນ
epydoc ມີຄວາມຫຍຸ້ງຍາກກັບ zope.interface, ແຕ່ສາມາດໃຊ້ສໍາລັບລະຫັດທີ່ບໍ່ແມ່ນ Zope Python ເປັນ.
ດີ.

OPTIONS

-h, - ຊ່ວຍ
ສະແດງຂໍ້ຄວາມຊ່ວຍເຫຼືອນີ້ ແລະອອກ

-c ຕັ້ງຄ່າ, --config=ຕັ້ງຄ່າ
ໃຊ້ config ຈາກໄຟລ໌ນີ້ (ທຸກແຖວຄໍາສັ່ງ override ການຕັ້ງຄ່າຈາກ
ໄຟລ).

-p INPUTPICKLE, --ປ້ອນ-ດອງ=INPUTPICKLE
ໂຫລດລະບົບຈາກໄຟລ໌ pickle ນີ້ (ຄ່າເລີ່ມຕົ້ນ: ບໍ່ມີ, ລະບົບເປົ່າແມ່ນສ້າງ).

-o OUTPUTPICKLE, --ຜົນຜະລິດ-ດອງ=OUTPUTPICKLE
ບັນທຶກລະບົບໃສ່ໄຟລ໌ pickle ນີ້ (ຄ່າເລີ່ມຕົ້ນ: ບໍ່ມີ, ລະບົບບໍ່ໄດ້ບັນທຶກໂດຍ
ໃນຕອນຕົ້ນ).

-- ລະບົບພິເສດ=ສ:URLPREFIX
ຊອກຫາວັດຖຸຢູ່ໃນລະບົບນີ້. ການເຊື່ອມຕໍ່ກັບວັດຖຸເຫຼົ່ານີ້ຈະມີ URLPREFIX
prepended ໃຫ້ເຂົາເຈົ້າ.

--ລະບົບ-ຊັ້ນ=SYSTEMCLASS
ຊື່ຈຸດຂອງຫ້ອງຮຽນເພື່ອໃຊ້ເພື່ອສ້າງລະບົບ.

--ຊື່ໂຄງການ=PROJECTNAME
ຊື່ໂຄງການ, ປາກົດຢູ່ໃນ html.

--project-url=PROJECTURL
url ໂຄງການ, ປາກົດຢູ່ໃນ html ຖ້າໃຫ້.

--project-base-dir=ໂຄງການພື້ນຖານ
ເສັ້ນທາງຢ່າງແທ້ຈິງໄປຫາໄດເລກະທໍລີພື້ນຖານຂອງໂຄງການ. ການເຊື່ອມໂຍງແຫຼ່ງຈະຖືກຄິດໄລ່
ອີງໃສ່ມູນຄ່ານີ້.

-- ການ​ທົດ​ສອບ​
ຢ່າຈົ່ມຖ້າການແລ່ນບໍ່ມີຜົນກະທົບໃດໆ.

--pdb ເຊັ່ນດຽວກັນກັບ py.test's --pdb.

--make-html
ຜະລິດຜົນຜະລິດ html.

--ເຊີບເວີ
ຮັບໃຊ້ HTML ໃນເຄື່ອງແມ່ຂ່າຍທ້ອງຖິ່ນ.

--ພອດເຊີບເວີ=SERVER_PORT
ພອດສໍາລັບ --ເຊີບເວີ ການນໍາໃຊ້.

--ທ້ອງຖິ່ນເທົ່ານັ້ນ
ຜູກມັດເຊີບເວີກັບ localhost ເທົ່ານັ້ນ.

-- ຫັນ​ຫນ້າ​ທາງ​=FACING_PATH
ຕັ້ງຄ່າ VHostMonster, ດ້ວຍຄວາມສັບສົນທັງຫມົດທີ່ຊີ້ໃຫ້ເຫັນ.

--ດັດແກ້ ເມື່ອຮັບໃຊ້ HTML, ອະນຸຍາດໃຫ້ແກ້ໄຂ.

--ບໍ່ກວດ
ເມື່ອຮັບໃຊ້ HTML ແລະອະນຸຍາດໃຫ້ແກ້ໄຂ, ຢ່າກວດເບິ່ງ docstrings ທັງຫມົດກ່ອນ.

--add-package=PACKAGEDIR
ເພີ່ມຊຸດໃສ່ລະບົບ. ສາມາດຊ້ຳໄດ້ເພື່ອເພີ່ມຫຼາຍກວ່າໜຶ່ງຊຸດ.

--add-module=ແບບ ຈຳ ລອງ
ເພີ່ມໂມດູນໃສ່ລະບົບ. ສາມາດຊໍ້າຄືນໄດ້.

--prepend-package=PREPENDEDPACKAGE
ທຳທ່າວ່າຊຸດທັງໝົດຢູ່ໃນອັນນີ້. ສາ​ມາດ​ນໍາ​ໃຊ້​ເພື່ອ​ເອ​ກະ​ສານ​ສ່ວນ​ຫນຶ່ງ​ຂອງ a
package

--ແກ້ໄຂ-ນາມແຝງ
ນີ້ປັບປຸງການອ້າງອີງເຖິງຊັ້ນຮຽນທີ່ນໍາເຂົ້າຈາກໂມດູນທີ່ເຂົາເຈົ້າເປັນ
ນໍາເຂົ້າໄປຫາການອ້າງອີງເຖິງບ່ອນທີ່ພວກເຂົາຖືກກໍານົດ.

--abbreviate-specialcase=ABREVMAPPING
ນີ້ແມ່ນລາຍການທີ່ແຍກກັນດ້ວຍເຄື່ອງໝາຍຈຸດຂອງ key=value pairs. ບ່ອນທີ່ກະແຈໃດນຶ່ງກົງກັບ a
ຊື່ໂມດູນແລະຄ່າແມ່ນຕົວຫຍໍ້ທີ່ຕ້ອງການ. ນີ້ສາມາດຖືກນໍາໃຊ້ເພື່ອແກ້ໄຂ
ຂໍ້ຂັດແຍ່ງກັບຕົວຫຍໍ້ທີ່ທ່ານມີສອງຫຼືຫຼາຍກວ່າໂມດູນທີ່ເລີ່ມຕົ້ນດ້ວຍ
ຈົດໝາຍດຽວກັນ. ຕົວຢ່າງ: twistedcaldav=tcd.

-- ຮູບແບບເອກະສານ=ເອກະສານ
docstrings ຮູບແບບທີ່ຮອງຮັບ epydoc ຖືກສົມມຸດວ່າຢູ່ໃນ.

--html-ວິຊາ=ຫົວຂໍ້ HTML
ຊື່ເຕັມຂອງວັດຖຸທີ່ຈະສ້າງ API docs ສໍາລັບ (ຄ່າເລີ່ມຕົ້ນ: ທຸກຢ່າງ).

--html-summary-pages
ພຽງແຕ່ສ້າງຫນ້າສະຫຼຸບ.

--html-write-function-pages
ສ້າງໄຟລ໌ HTML ສ່ວນບຸກຄົນສໍາລັບທຸກໆຫນ້າທີ່ແລະວິທີການ. ເຂົາເຈົ້າບໍ່ໄດ້ເຊື່ອມຕໍ່ກັບໃນ
ໃດໆທີ່ pydoctorgenerated HTML, ແຕ່ພວກເຂົາສາມາດເປັນປະໂຫຍດສໍາລັບການເຊື່ອມໂຍງຂອງພາກສ່ວນທີສາມ.

--html-output=HTMLOUTPUT
ໄດເລກະທໍລີເພື່ອບັນທຶກໄຟລ໌ HTML ເປັນ (ຄ່າເລີ່ມຕົ້ນ 'apidocs')

--html-writer=HTMLWRITER
ຊື່ຈຸດຂອງຫ້ອງຮຽນ html writer ທີ່ຈະໃຊ້ (ຄ່າເລີ່ມຕົ້ນ 'pydoctor.nevowhtml.NevowWriter',
ຮຽກ​ຮ້ອງ​ໃຫ້​ມີ Divmod Nevo ໄດ້​ຮັບ​ການ​ຕິດ​ຕັ້ງ​)​.

--html-viewsource-base=HTMLSOURCEBASE
ນີ້ຄວນຈະເປັນເສັ້ນທາງໄປຫາຕົວທ່ອງເວັບ trac ສໍາລັບທາງເທິງຂອງ svn checkout ທີ່ພວກເຮົາຢູ່
ເອກະສານສ່ວນຫນຶ່ງຂອງ.

--html-use-sortable
ໃຊ້ຫ້ອງສະຫມຸດ JS ທີ່ສາມາດຈັດລຽງໄດ້ເພື່ອເຮັດໃຫ້ຕາຕະລາງຂອງຊຸດ, ໂມດູນແລະເນື້ອໃນຫ້ອງຮຽນ
ຈັດລຽງໄດ້

--html-use-splitlinks
ສ້າງ JavaScript (ບໍ່ລົບກວນ) ເພື່ອອະນຸຍາດໃຫ້ວິທີການຫ້ອງຮຽນສະແດງໃຫ້ເຫັນບໍ່ວ່າຈະຢູ່ໃນອັນດຽວ
ຕາຕະລາງຕໍ່ຊັ້ນພື້ນຖານຫຼືໃນຕາຕະລາງໃຫຍ່ຫນຶ່ງ.

--html-shorten-lists
ສ້າງ JavaScript (ບໍ່ລົບກວນ) ເພື່ອຊ່ອນບາງລາຍການຢູ່ໃນບັນຊີລາຍຊື່ຍາວຂອງ
ຕົວຢ່າງ: ຊັ້ນຍ່ອຍ.

--ກວດສົດ
ນໍາເຂົ້າແລະກວດເບິ່ງໂມດູນເຊັ່ນກັນ. XXX ບໍ່ເຮັດວຽກໃນຕອນນີ້

-v, -- verbose
ດັງຂຶ້ນ. ສາມາດໄດ້ຮັບການຊ້ໍາສໍາລັບສິ່ງລົບກວນຫຼາຍ.

-q, --ງຽບ
ງຽບກວ່າ.

--ອັດຕະໂນມັດ ໂຫມດອັດຕະໂນມັດ: ວິເຄາະທຸກໂມດູນແລະແພັກເກັດທີ່ຢູ່ໃນໄດເລກະທໍລີທີ່ເຮັດວຽກໃນປະຈຸບັນ
ແລະດໍາເນີນການເຄື່ອງແມ່ຂ່າຍທ້ອງຖິ່ນທີ່ອະນຸຍາດໃຫ້ກວດສອບແລະແກ້ໄຂ docstrings.

--verbose-ກ່ຽວກັບ=ຂັ້ນຕອນຂອງການ
ມີສຽງດັງໃນລະຫວ່າງຂັ້ນຕອນຂອງການຜະລິດ.

ໃຊ້ pydoctor ອອນໄລນ໌ໂດຍໃຊ້ບໍລິການ onworks.net