dm.zdoc ay isang maliit na Python wrapper sa paligid pydoc upang gawin itong kapaki-pakinabang para sa Zope.
Tandaan: bersyon Python sa ibaba 2.6 Kulang mahusay na suporta para sa namespace pakete sa pydoc. Habang Zope mismo ay hindi gumagamit namespace pakete bago bersyon 2.12 (na gumagamit ng Python 2.6), mahalagang Zope application (tulad ng Plone) ko gagamitin pakete namespace. Sa mga kasong ito, ang pagdodokumento ng ginawa ni pydoc (at sa pamamagitan ng zdoc extension) ay hindi kumpleto.
Paggamit
zdoc ay maaaring gamitin sa pamamagitan ng script dmzdoc, sa pamamagitan ng module ng pag-import o pinagsanib na sa pagtakbo Zope halimbawa.
Sa unang dalawang mga kaso na maaari itong maging kinakailangan upang itakda ang Zope kapaligiran variable INSTANCE_HOME at SOFTWARE_HOME upang sabihin sa zdoc kung saan ay matatagpuan sa Zope mga pinagmulan.
Gamitin pamamagitan ng dmzdoc
Ang script dmzdoc naka-install kapag mayroon kang naka-install na setuptools.
Kung hindi, dapat mong i-install ito sa iyong sarili. Ito ay may mga sumusunod na nilalaman:
-import dm.zdoc; dm.zdoc.cli ()
May eksaktong parehong mga pagpipilian at mga parameter bilang pydoc, dokumentado sa pydoc dmzdoc.
Gamitin ang module sa pamamagitan ng pag-import
Ang module dm.zdoc tumutukoy sa parehong bagay bilang pydoc, dokumentado sa pydoc.
Pinagsama sa isang tumatakbo Zope Halimbawa
Para sa paggamit na ito, kailangan mong i-install ang module sa iyong pag-install Zope at i-activate nito configure.zcml sa Zope startup. Magbibigay ito sa "Zope Root Folder" view@@zdoc na nagtatanghal ng mga papeles sa parehong paraan tulad ng pydoc http server.
pansin: paglalantad ang dokumentasyon ng isang Zope halimbawa sa ganitong paraan ay nagbibigay ng makabuluhang pananaw at maaaring magbigay sa mga hacker mahalagang mga pahiwatig para sa mga pag-atake. Malamang, nag-install ka ito lamang sa paglitaw ng pag-unlad sa mga pinaghihigpitang access
Ano ang bagong sa paglabas:.
- Suporta para sa & quot; na isinama sa isang runnging Zope Halimbawa & quot; kaso ng paggamit
Mga Kinakailangan :
- Python
Mga Komento hindi natagpuan