dm.zdoc er en liten Python wrapper rundt pydoc å gjøre det brukbart for Zope.
Merk: Python-versjoner under 2.6 mangler god støtte for navnerom pakker i pydoc. Mens Zope selv ikke bruker namespace pakker før versjon 2.12 (som bruker Python 2.6), viktige Zope programmer (for eksempel Plone) gjøre bruke namespace pakker. I disse tilfellene er det dokumentasjon produsert av pydoc (og i forlengelsen zdoc) ufullstendig.
Bruk
zdoc kan enten brukes via script dmzdoc, via modul import eller integrert i en løpende Zope eksempel.
I de to første tilfellene kan det være nødvendig å stille Zope miljøvariabler INSTANCE_HOME og SOFTWARE_HOME å fortelle zdoc hvor Zope kilder kan bli funnet.
Bruke via dmzdoc
Skriptet dmzdoc er installert når du har setuptools installert.
Ellers må du installere det selv. Den har følgende innhold:
import dm.zdoc; dm.zdoc.cli ()
dmzdoc har akkurat de samme alternativene og parametere som pydoc, dokumentert i pydoc.
Bruk via modul import
Modulen dm.zdoc definerer de samme objektene som pydoc, dokumentert i pydoc.
Integrert i en løpende Zope forekomst
For denne bruken, må du installere modulen i Zope installasjon og aktivere sin configure.zcml på Zope oppstart. Dette vil gi "Zope Root Folder" utsikten@@zdoc som presenterer dokumentasjon på samme måte som den pydoc http server.
MERK: Utsette dokumentasjon av en Zope eksempel på denne måten gir fornuftige innsikt og kan gi hackere verdifulle ledetråder for angrep. Sannsynlig, vil du installere dette bare i utviklings tilfeller med begrenset tilgang
Hva er nytt i denne utgaven:.
- Støtte for & quot; integrert i en runnging Zope eksempel & quot; use case
Krav :
- Python
Kommentarer ikke funnet