pydoctor - Online na nuvem

PROGRAMA:

NOME

pydoctor - gerador de documentação API para Python

SINOPSE

médico [opções]

DESCRIÇÃO

Pydoctor é um gerador de documentação de API que funciona principalmente por análise estática.

Foi escrito principalmente para substituir o epydoc para os fins do projeto Twisted como
epydoc tem dificuldades com zope.interface, mas pode ser usado para código Python não Zope como
bem.

OPÇÕES

-h, --Socorro
mostre esta mensagem de ajuda e saia

-c CONFIGURAÇÃO, --config=CONFIGURAR
Use a configuração deste arquivo (qualquer opção de linha de comando substitui as configurações do
arquivo).

-p ENTRADA PICOLÉ, --input-picle=ENTRADA PICKLE
Carregue o sistema a partir deste arquivo pickle (padrão: nenhum, um sistema em branco é criado).

-o SAÍDA PICOLÉ, --saída-picle=SAÍDA PICOLÉ
Salve o sistema neste arquivo pickle (padrão: nenhum, o sistema não é salvo por
predefinição).

--extra-sistema=SYS: URLPREFIX
Procure objetos neste sistema para. Links para esses objetos terão URLPREFIX
prefixado a eles.

--classe do sistema=CLASSE DE SISTEMA
Um nome pontilhado da classe a ser usado para fazer um sistema.

--Nome do Projeto=NOME DO PROJETO
O nome do projeto, aparece no html.

--projeto-url=PROJETO
O url do projeto, aparece no html, se fornecido.

--project-base-dir=PROJETOBASEDIRETÓRIO
Caminho absoluto para o diretório base do projeto. Links de origem serão calculados
com base neste valor.

--teste
Não reclame se a corrida não tiver nenhum efeito.

--pdb Como py.test's --pdb.

--make-html
Produza saída html.

--servidor
Sirva HTML em um servidor local.

--porta do servidor=SERVER_PORT
A porta para --servidor para usar.

- somente local
Vincule o servidor apenas ao host local.

--face-path=FACING_PATH
Configure um VHostMonster, com toda a confusão que isso implica.

--editar Ao servir HTML, permita a edição.

- não verificar
Ao servir HTML e permitir a edição, não verifique todas as docstrings primeiro.

--add-pacote=DIR DO PACOTE
Adicione um pacote ao sistema. Pode ser repetido para adicionar mais de um pacote.

--add-módulo=MÓDULO
Adicione um módulo ao sistema. Pode ser repetido.

--prepend-pacote=PACOTE PREPENDIDO
Finja que todos os pacotes estão dentro deste. Pode ser usado para documentar parte de um
pacote.

--resolver-aliases
Isso atualiza as referências a classes importadas de um módulo no qual foram
importados para referências onde são definidos.

--abbreviar-caso especial=MAPEAMENTO ABREV
Esta é uma lista separada por vírgulas de pares chave = valor. Onde qualquer chave corresponde a um
o nome e o valor do módulo é a abreviatura desejada. Isso pode ser usado para resolver
entra em conflito com a abreviatura onde você tem dois ou mais módulos que começam com o
mesma letra. Exemplo: twistedcaldav = tcd.

--docformato=DOCFORMAT
Em que docstrings de formato compatível com epydoc devem estar.

--html-assunto=ASSUNTOS HTML
O fullName do objeto para o qual gerar documentos API (padrão: tudo).

--html-resumo-páginas
Gere apenas as páginas de resumo.

--html-write-function-pages
Faça arquivos HTML individuais para cada função e método. Eles não estão vinculados a
qualquer HTML gerado por pydoctor, mas podem ser úteis para links de terceiros.

--html-saída=SAÍDA HTML
Diretório para salvar os arquivos HTML (padrão 'apidocs')

--html-escritor=ESCRITOR HTML
Nome pontilhado da classe do gravador html a ser usada (padrão 'pydoctor.nevowhtml.NevowWriter',
requer a instalação do Divmod Nevow).

--html-viewsource-base=HTML SOURCEBASE
Este deve ser o caminho para o navegador trac para o topo do checkout svn que estamos
documentando parte de.

--html-use-classificável
Use a biblioteca JS de tabela de classificação para fazer tabelas de conteúdo de pacote, módulo e classe
classificável

--html-use-divididos
Gere JavaScript (não obstrutivo) para permitir que métodos de classe sejam mostrados em um
tabela por classe base ou em uma grande mesa.

--html-encurtar-listas
Gere JavaScript (não obstrutivo) para ocultar algumas das entradas em longas listas de
por exemplo, subclasses.

--livecheck
Importe e examine os módulos também. XXX não está funcionando agora

-v, --verbose
Seja mais barulhento. Pode ser repetido para mais ruído.

-q, --quieto
Fique mais quieto.

--auto Modo Automagic: analisa todos os módulos e pacotes no diretório de trabalho atual
e executar um servidor local que permite o exame e edição das docstrings.

--verbose-sobre=etapa
Seja mais barulhento durante um determinado estágio de geração.

Use pydoctor online usando serviços onworks.net