2 Estructura de los directorios

La distribución fuente de la documentación estándar de Python contiene muchos directorios. A pesar de no es necesario que los documentos de terceros se coloquen en esta estructura o una similar, puede ayudar saber dónde buscar ejemplos y herramientas al desarrollar nuevos documentos usando las herramientas de documentación de Python. Esta sección describe esta estructura de directorios.

Las fuentes de la documentación suelen estar ubicadas inmediatamente dentro de la distribución fuente de Python en el directorio Doc/, pero no dependen de la distribución fuente de Python en modo alguno.

El directorio Doc/ contiene varios ficheros y subdirectorios. Los ficheros son autoexplicativos. Incluyen un README (léeme) y un Makefile (fichero de dependencias para la generación de la documentación final). Los directorios se dividen en tres categorías:

Fuentes de documentos

Las fuentes L^ATEX de cada documento se sitúan en un directorio aparte. Estos directorios reciben nombres de tres caracteres:

Directorio Título del documento

api/ La API de Python/C
dist/ Distribución de módulos Python
doc/ Documentar Python
ext/ Extensión y empotrado del intérprete de Python
inst/ Instalación de módulos Python
lib/ Referencia de la biblioteca de Python
mac/ Referencia de módulos de Macintosh
ref/ Manual de referencia de Python
tut/ Guía de aprendizaje de Python

Salida dependiente del formato

Directorio	Título del documento
`api/`	La API de Python/C
`dist/`	Distribución de módulos Python
`doc/`	Documentar Python
`ext/`	Extensión y empotrado del intérprete de Python
`inst/`	Instalación de módulos Python
`lib/`	Referencia de la biblioteca de Python
`mac/`	Referencia de módulos de Macintosh
`ref/`	Manual de referencia de Python
`tut/`	Guía de aprendizaje de Python

La mayoría de los formatos de salida tienen un directorio que contiene un Makefile que controla la generación del formato y recoge la salida de los documentos finales. Las únicas variaciones sobre esta categoría son el formato PDF (Portable Document Format, Formato portátil de documento) y el formato PostScript, recogidos en los directorios paper-a4/ y paper-letter/ (esto causa que los ficheros temporales creados por L^ATEX queden en el mismo lugar para cada tamaño de papel, en donde pueden ser ignorados fácilmente).

Directorio Formatos de salida

html/ Salida HTML
info/ Salida en info GNU
paper-a4/ PDF y PostScript, A4
paper-letter/ PDF y PostScript, papel US-Letter (carta)

Archivos adicionales

Directorio	Formatos de salida
`html/`	Salida HTML
`info/`	Salida en info GNU
`paper-a4/`	PDF y PostScript, A4
`paper-letter/`	PDF y PostScript, papel US-Letter (carta)

Se usan directorios adicionales para almacenar archivos adicionales que utilizan los diversos procesos. Se incluyen directorios para las clases de documentos L^ATEX compartidas, soporte L^ATEX2HTML, plantillas para diversos componentes de los documentos y los guiones usados para realizar diversos pasos del proceso de formato.

Directorio Contenido

perl/ Suporte al procesado L^ATEX2HTML
templates/ Plantillas para documentos fuente
texinputs/ Implementación del estilo L^ATEX
tools/ Guiones de procesado a medida

Directorio	Contenido
`perl/`	Suporte al procesado L^ATEX2HTML
`templates/`	Plantillas para documentos fuente
`texinputs/`	Implementación del estilo L^ATEX
`tools/`	Guiones de procesado a medida

Ver Sobre este documento... para obtener información sobre sugerencias.