Este es el comando sphinx-apidoc 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
sphinx-apidoc: herramienta generadora de documentos API de Sphinx
SINOPSIS
esfinge-apidoc [opciones] -odirectorio de salida>fuenteir> [nombres de ruta ...]
DESCRIPCIÓN
esfinge-apidoc es una herramienta para la generación automática de fuentes Sphinx que, utilizando el autodoc
extensión, documenta un paquete completo al estilo de otra documentación de API automática
herramientas.
fuenteir debe apuntar a un paquete de Python. Alguna nombres de ruta dados son caminos para ser excluidos
de la generación.
ADVERTENCIA:
esfinge-apidoc genera archivos fuente que usan esfinge.ext.autodoc para documentar todo lo encontrado
módulos. Si algún módulo tiene efectos secundarios en la importación, estos serán ejecutados por autodoc
when construcción de esfinge se ejecuta.
Si documenta scripts (a diferencia de los módulos de la biblioteca), asegúrese de que su rutina principal
está protegido por un if __nombre__ == '__principal__' condición.
OPCIONES
-o
Directorio para colocar los archivos de salida. Si no existe, se crea.
-f, --fuerza
Por lo general, apidoc no sobrescribe archivos, a menos que se proporcione esta opción.
-l, --enlaces de seguimiento
Siga los enlaces simbólicos.
-n, - corrida en seco
Si se proporciona, apidoc no crea ningún archivo.
-s
Sufijo para los archivos fuente generados, el valor predeterminado es rst.
-d
Profundidad máxima para el archivo de tabla de contenido generado.
-T, --no-toc
No cree un archivo de tabla de contenido.
-F, --lleno
Si se da, se genera un proyecto Sphinx completo (conf.py, Makefile etc.) usando
esfinge-inicio rápido.
-e, --separar
Coloque cada archivo de módulo en su propia página.
-E, --no-encabezados
No cree títulos para los módulos / paquetes
-P, --privado
Incluir módulos "_private"
Estas opciones se utilizan con -F:
-H
Nombre del proyecto para poner en la configuración.
-A
Nombre (s) de autor para poner en la configuración.
-V
Versión del proyecto.
-R
Lanzamiento del proyecto.
Utilice sphinx-apidoc en línea utilizando los servicios de onworks.net
