 |
 |
 |
Documentar Python |  |
 |
|
|
|
|
Documentar Python | |
|
|
Se definen dos clases de documento LATEX específicas para usarlas con
la documentación de Python. La clase manual se usa para los
documentos extensos, divididos en capítulos, y la clase howto
(cómo), utilizada para documentos más breves.
Los documentos manual son más extensos y se utilizan para la
mayoría de los documentos estándar. Esta clase de documento se basa
en la clase estándar de LATEX report y recibe un formato
muy similar a la un extenso informe técnico. El
Manual de referencia de Python es un
buen ejemplo de documento manual la
Referencia de bibliotecas de Python
sirve como ejemplo extenso.
Los documentos howto son más cortos y no tienen la extensa
estructura de los documentos manual. Esta clase se basa en la
clase estándar de LATEX article (artículo) y recibe un formato
similar al los ``HOWTO'' del Proyecto de documentación de Linux
(LDP en inglés),
basados en el software LinuxDoc. La intención original de la clase
del documento era que representara un papel similar a la serie de
HOWTO del LDP, pero la validez de la clase ha resultado ser más amplia.
Esta clase se utiliza para documentos ``cómo'' (este documento sirve
de ejemplo) y para manuales de referencia más breves para bibliotecas
de módulos pequeñas y homogéneas. Como ejemplo de este uso, sirven
los documentos estándar Módulos de la
biblioteca Macintosh y
Using
Kerberos from Python (Uso de Kerberos desde Python), que contiene
material de referencia de un paquete de extensión. Estos documentos
equivalen de manera burda a un solo capítulo de lo que sería una
obra más extensa.
|
|
|
Documentar Python | |
|
|