dm.zdoc

dm.zdoc er en lille Python wrapper omkring pydoc at gøre det brugbart for Zope.
Bemærk: Python versioner under 2,6 mangler god støtte til namespace pakker i pydoc. Mens Zope ikke selv bruge namespace pakker før versionen 2.12 (som bruger Python 2.6), vigtige Zope programmer (såsom Plone) benytter namespace pakker. I disse tilfælde, den produceres af pydoc (og i forlængelse zdoc) dokumentation er ufuldstændig.
Anvendelse
zdoc kan enten bruges via script dmzdoc via modul import eller integreret i en kørende Zope instans.
I de to første tilfælde kan det være nødvendigt at indstille Zope miljøvariabler INSTANCE_HOME og SOFTWARE_HOME at fortælle zdoc hvor der kan findes de Zope kilder.
Brug via dmzdoc
Scriptet dmzdoc installeres, når du har setuptools installeret.
Ellers skal du installere det selv. Det har følgende indhold:
import dm.zdoc; dm.zdoc.cli ()
dmzdoc har præcis de samme muligheder og parametre som pydoc, dokumenteret i pydoc.
Brug via modul import
Modulet dm.zdoc definerer de samme objekter som pydoc, dokumenteret i pydoc.
Integreret i en kørende Zope instans
Til denne brug, skal du installere modulet i din Zope installation og aktivere sin configure.zcml på Zope opstart. Dette vil give "Zope Root Folder" visningen@@zdoc som præsenterer dokumentation på samme måde som pydoc HTTP-server.
OBS: udsættes dokumentationen af ​​en Zope instans på denne måde giver fornuftige indsigt og kunne give hackere værdifulde spor for angreb. Sandsynligt, vil du installerer denne kun i udviklings- tilfælde med begrænset adgang

Hvad er nyt i denne udgivelse:.

• Understøttelse af & quot; integreret i en runnging Zope instans & quot; use case

Krav :

• Python