 |
 |
 |
Documentar Python |  |
 |
|
|
|
|
Documentar Python | |
|
|
Esta sección es una breve introducción a conceptos y sintaxis de LATEX, para proporcionar a los autores suficiente información para crear documentos sin tener que convertirse en ``TEXnicos''.
Quizás el concepto más importante a tener presente al poner marcas a la documentación de Python es que, mientras TEX no tiene estructura, LATEX se diseñó como una capa sobre TEX con soporte específico de marcaje estructurado. La intención del marcaje específico de Python es extender la estructura proporcionada por las clases de documento estándar de LATEX para dar soporte a información adicional específica de Python.
Los documentos LATEX contienen dos partes: el preámbulo y el cuerpo. El preámbulo se usa para especificar ciertos metadatos sobre el propio documento, tales como el título, la lista de autores, la fecha y la clase a la que pertenece el documento. Se puede incluir información adicional para controlar la generación de índices y el uso de bases de datos bibliográficas. En la mayoría de los casos, se puede crear el preámbulo copiándolo de un documento existente y modificando los detalles relevantes.
Se utiliza la clase de un documento para ubicarlo dentro de una
amplia categoría de documentos y fijar algunas propiedades de formato
fundamentales. En la documentación de Python se usan dos clases:
La clase manual y la clase howto (cómo). Estas clases
también definen el marcaje adicional utilizado para documentar conceptos
y estructuras propios de Python. Hay información específica sobre estas
clases en la sección posterior
Tras la declaración de la clase, pueden venir algunas macros utilizadas para proporcionar información adicional sobre el documento y declarar marcas adicionales. El preámbulo no debe generar salida, por lo que no se debe incluir texto libre en él.
El cuerpo del documento sigue al preámbulo y contiene todos los componentes impresos del documento más su marcaje estructurado.
|
|
|
Documentar Python | |
|
|