 |
 |
 |
Documentar Python |  |
 |
|
|
|
|
Documentar Python | |
|
|
La documentación de Python suele ser considerada de buena calidad para un lenguaje de programación gratuito. Hay varios motivos, siendo el más importante el temprano compromiso del creador de Python, Guido van Rossum, con la provisión de documentación sobre el lenguaje y sus bibliotecas y la continua aparición de voluntarios para crear y mantener documentación.
El compromiso de la comunidad toma muchas formas, desde la creación a informes de error a las simples quejas cuando la documentación pudiera ser más completa o fácil de usar. Todas estas formas de realimentación desde la comunidad han demostrado su utilidad durante el tiempo en el que he estado involucrado en el mantenimiento de la documentación.
Este documento va dirigido a autores y potenciales autores de documentación para Python. Más concretamente, es para gente que contribuya a la documentación estándar y desarrolle documentos adicionales utilizando las mismas herramientas que los documentos estándar. Esta guía será menos útil para los autores que utilicen las herramientas de documentación de Python para otros temas y aún menos útil para los autores que no utilicen estas herramientas en absoluto.
El material de esta guía va dirigido a asistir a los autores que utilicen las herramientas de documentación de Python. Incluye información sobre la distribución en código fuente de la documentación estándar, una discusión sobre los tipos de documentos, material de referencia sobre las marcas definidas en las clases de documentos, una lista de herramientas externas necesarias para el procesado de los documentos y material de referencia sobre las herramientas proporcionadas con los recursos de la documentación. Al final hay también una sección que discute el futuro de la documentación de Python y una lista de material de referencia.
|
|
|
Documentar Python | |
|
|