Documentar Python

Anterior: 7.1 Herramientas externas Niv. superior: 7 Herramientas de proceso Siguiente: 8 Tendencias de futuro

---

7.2 Herramientas internas

Esta sección describe los diversos guiones utilizados para implementar las etapas de procesado de documentos o para gestionar la secuencia de generación completa. La mayoría de estas herramientas sólo son útiles en el contexto de la generación de la documentación estándar, aunque algunas son más generales.

mkhowto

El guion principal utilizado para dar formato a documentos de terceros. Contiene toda la lógica necesaria para ``obtener resultados''. El modo correcto de usar este guion es hacer un enlace simbólico² o ejecutarlo en el propio lugar. El guion real debe almacenarse como parte del árbol de las fuentes de la documentación, aunque se puede usar para dar formato a documentos que no se hallen en él. Ejecuta mkhowto --help para obtener una lista de las opciones de la línea de órdenes.

mkhowto puede usarse tanto para documentos de la clase howto como para documentos manual (en el segundo caso, asegúrate de obtener la última versión del repositorio CVS de python, en lugar de la versión distribuida con el archivo de fuentes latex-1.5.2.tgz).

Notas al pie

... simbólico²

N. del T. El término ``enlace simbólico'' se usa en Unix, el equivalente en Windows es, vagamente, el acceso directo.

---

Documentar Python

Anterior: 7.1 Herramientas externas Niv. superior: 7 Herramientas de proceso Siguiente: 8 Tendencias de futuro