Este es el comando pydoctor que se puede ejecutar en el proveedor de alojamiento gratuito de OnWorks utilizando una de nuestras múltiples estaciones de trabajo en línea gratuitas, como Ubuntu Online, Fedora Online, emulador en línea de Windows o emulador en línea de MAC OS.
PROGRAMA:
NOMBRE
pydoctor - generador de documentación de API para Python
SINOPSIS
pydoctor [opciones]
DESCRIPCIÓN
Pydoctor es un generador de documentación API que funciona principalmente mediante análisis estático.
Fue escrito principalmente para reemplazar epydoc a los efectos del proyecto Twisted como
epydoc tiene dificultades con zope.interface, pero se puede utilizar para código Python que no sea de Zope como
bien.
OPCIONES
-h, --ayuda
mostrar este mensaje de ayuda y salir
-c ARCHIVO DE CONFIGURACIÓN, --config=ARCHIVO DE CONFIGURACIÓN
Utilice la configuración de este archivo (cualquier opción de línea de comando anula la configuración de la
de archivo).
-p ENTRADA PINTADO, --encurtido de entrada=ENTRADA PICKLE
Cargue el sistema desde este archivo pickle (predeterminado: ninguno, se crea un sistema en blanco).
-o SALIDA ENCURTIDOS, --salida-encurtido=SALIDAPICKLE
Guarde el sistema en este archivo pickle (predeterminado: ninguno, el sistema no se guarda mediante
defecto).
--extra-sistema=SYS: URLPREFIX
Busque objetos en este sistema para. Los enlaces a estos objetos tendrán URLPREFIX
antepuesto a ellos.
- clase de sistema=CLASE DE SISTEMA
Un nombre con puntos de la clase que se utilizará para crear un sistema.
--nombre del proyecto=NOMBRE DEL PROYECTO
El nombre del proyecto aparece en html.
--URL del proyecto=URL DEL PROYECTO
La URL del proyecto aparece en el html si se proporciona.
--proyecto-base-dir=DIRECTORIO BASADO EN PROYECTO
Ruta absoluta al directorio base del proyecto. Los enlaces de origen se calcularán
basado en este valor.
--pruebas
No te quejes si la carrera no tiene ningún efecto.
--pdb Como py.test's --pdb.
--hacer-html
Producir salida html.
--servidor
Sirve HTML en un servidor local.
--Puerto de servicio=SERVER_PORT
El puerto de --servidor usar.
--solo locales
Vincula el servidor solo a localhost.
- camino-orientado=RUTA_ENFRENTADA
Configura un VHostMonster, con toda la confusión que eso implica.
--editar Cuando sirva HTML, permita la edición.
--sin verificación
Cuando sirva HTML y permita la edición, no compruebe primero todas las cadenas de documentos.
--add-paquete=PAQUETEDIR
Agregue un paquete al sistema. Puede repetirse para agregar más de un paquete.
--add-módulo=MÓDULO
Agregue un módulo al sistema. Puede repetirse.
--prepago-paquete=PAQUETE PREPENDIDO
Imagina que todos los paquetes están dentro de este. Puede utilizarse para documentar parte de un
Pack
--resolver-alias
Esto actualiza las referencias a las clases importadas de un módulo en el que fueron
importados a referencias a donde están definidos.
--abreviate-specialcase=ABREVMAPPING
Esta es una lista separada por comas de pares clave = valor. Donde cualquier clave corresponde a un
el nombre y el valor del módulo es la abreviatura deseada. Esto se puede utilizar para resolver
entra en conflicto con la abreviatura donde tiene dos o más módulos que comienzan con el
misma letra. Ejemplo: twistedcaldav = tcd.
--docformato=DOCFORMATO
En qué formato se supone que están las cadenas de documentación de formato compatible con epydoc.
--html-asunto=HTMLSUJETOS
El nombre completo del objeto para generar documentos API (predeterminado: todo).
--html-páginas-de-resumen
Genere únicamente las páginas de resumen.
--html-escribir-funciones-páginas
Cree archivos HTML individuales para cada función y método. No están vinculados a
cualquier HTML generado por pydoctor, pero pueden ser útiles para enlaces de terceros.
--html-salida=SALIDA HTML
Directorio para guardar archivos HTML ('apidocs' predeterminado)
--html-escritor=ESCRITOR HTML
Nombre punteado de la clase de escritura html que se utilizará (por defecto 'pydoctor.nevowhtml.NevowWriter',
requiere la instalación de Divmod Nevow).
--html-viewsource-base=BASE DE FUENTE HTML
Esta debería ser la ruta al navegador trac para la parte superior de la caja de svn que estamos
documentar parte de.
--html-use-sorttable
Utilice la biblioteca JS clasificable para crear tablas de contenido de paquetes, módulos y clases
ordenable
--html-use-enlaces divididos
Genere JavaScript (discreto) para permitir que los métodos de clase se muestren en uno
mesa por clase base o en una mesa grande.
--html-abre-listas
Genere JavaScript (discreto) para ocultar algunas de las entradas en largas listas de
por ejemplo, subclases.
--comprobación en vivo
Importe y examine los módulos también. XXX no funciona en este momento
-v, --verboso
Sea más ruidoso. Puede repetirse para obtener más ruido.
-q, --tranquilo
Sea más silencioso.
--auto Modo automático: analiza todos los módulos y paquetes en el directorio de trabajo actual
y ejecutar un servidor local que permita examinar y editar las cadenas de documentos.
--verbio sobre=escenario
Sea más ruidoso durante una etapa particular de la generación.
Use pydoctor en línea usando los servicios de onworks.net
