dm.zdoc

dm.zdoc é um pequeno invólucro Python em torno pydoc para torná-lo utilizável para Zope.
Nota: versões do Python 2.6 abaixo falta um bom suporte para pacotes de namespace em pydoc. Enquanto próprio Zope não usa pacotes de namespace antes versão 2.12 (que usa Python 2.6), as aplicações Zope importantes (como Plone) usam pacotes de namespace. Nestes casos, a documentação produzida por pydoc (e por extensão zdoc) é incompleta.
Uso
zdoc pode ser utilizada através da dmzdoc roteiro, via importação módulo ou integrado em uma instância Zope em execução.
Nos dois primeiros casos, pode ser necessário ajustar o Zope variáveis ​​de ambiente INSTANCE_HOME e SOFTWARE_HOME dizer zdoc onde as fontes do Zope pode ser encontrado.
Use via dmzdoc
O dmzdoc script é instalado quando você tem setuptools instalados.
Caso contrário, você deve instalá-lo sozinho. Ele tem o seguinte conteúdo:
dm.zdoc importação; dm.zdoc.cli ()
dmzdoc tem exatamente as mesmas opções e parâmetros como pydoc, documentada em pydoc.
Use via importação do módulo
O dm.zdoc módulo define os mesmos objetos que pydoc, documentada em pydoc.
Integrado numa instância Zope executando
Para este uso, você deve instalar o módulo em sua instalação do Zope e ativar sua configure.zcml na inicialização do Zope. Isso dará a "Zope pasta raiz" o ponto de vista@@zdoc que apresenta a documentação da mesma forma como o servidor pydoc http.
ATENÇÃO: Expor a documentação de uma instância Zope, desta forma fornece insights sensatas e poderia dar pistas valiosas hackers para ataques. Provavelmente, você vai instalar este apenas em casos de desenvolvimento com acesso restrito

O que é novo nesta versão:.

• Suporte para o & quot; integrado num runnging Zope exemplo & quot; caso de uso

Requisitos :

• Python