Formas alternativas de explorar la aplicación python

¿Soy yo o la documentación de la biblioteca estándar de Python es extremadamente difícil de examinar?Formas alternativas de explorar la aplicación python

Java tiene su brillante Javadocs, Ruby tiene su Ruby-Docs útiles, sólo en Python no puedo encontrar una buena manera de navegar a través de la documentación de la biblioteca estándar.

Existe el proyecto Epydoc, que se ve bien, pero ¿alguien sabe si realmente se está utilizando en la biblioteca estándar, por lo que todos podemos pasar por ello? De lo contrario, ¿cuáles son las alternativas que las personas están utilizando para explorar la documentación de Python?

Fuente

2010-01-25 ivo

Python y muchas de las grandes bibliotecas utilizan Sphinx para la documentación. Desde el punto de vista de la usabilidad, los documentos generados son bastante horribles (a pesar de que usan CSS de buen aspecto). Un ejemplo de eso son las páginas extremadamente largas, lo que hace que navegar sea muy difícil. – nikow

Wow ... Python puede no ser el documento más maravilloso, ¿pero compararlo desfavorablemente con * javadoc *? El doc es mi cosa menos favorita de Java: normalmente recibes un pequeño tutorial superficial y luego solo está el javadoc: un laberinto inútil de detalles técnicos de clase y método sin instrucciones para encontrar cómo se arregla todo y lo que haces. re esperado a usar. – bobince

Considero que javadocs es una gran herramienta para explorar las API. La calidad de la documentación en sí no es responsabilidad de la herramienta, sino del autor de la documentación. Así que en mi humilde opinión, sí, los javadocs son mucho mejores que los que usa el sitio oficial de documentación de python. – ivo

Normalmente utilizo el pydoc incorporado, si está en Windows debe llamarse Módulo de Documentos si está en uso de Linux pydoc -p 8000 y conectarse a través del navegador.

Fuente

2010-01-25 10:30:29

puede ir al here y descargar la versión chm de Python 3.1. Con eso, buscar a través de los documentos debería ser fácil.

Fuente

2010-01-25 10:02:04 ghostdog74

pydoc desde la línea de comandos, help() desde el intérprete interactivo.

Fuente

2010-01-25 10:32:36

pydoc -p 8080

La comunidad Python es semi-hostil a genera automáticamente la documentación, especialmente si es orientado a objetos. Python no está solo orientado a objetos (es un lenguaje multi-paradigma), por lo que los desarrolladores de Python generalmente prefieren la documentación escrita por humanos. A veces las funciones son importantes, a veces la estructura de la clase es importante.

Fuente

2010-01-25 10:42:35 wisty

Sí, he probado algo de la hostilidad ... – ivo

Solía usar el python sidebar de Edgewall hace mucho tiempo.

En estos días, googleo la función python (los documentos estándar casi siempre aparecen como el primer enlace) .Si quiero navegar por la fuente del módulo (útil a veces), uso esta pequeña función de shell que escribí .

epy() { 
    cmd="import $1 as a ; print a.__file__.endswith('.pyc') and a.__file__[:-1] or a.__file__" 
    file=$(/usr/bin/env python -c $cmd) 
    echo $file 
    emacsclient --no-wait $file 
}

Fuente

2010-01-25 10:45:31

supongo que voy a conseguir downvoted pero no encuentro nada de malo en los documentos de la esfinge y las encuentro forma mucho mejor que la alternativa java.

Fuente

2010-01-30 09:14:42

Estoy de acuerdo. Sphinx es una buena herramienta y genera buenos documentos. Al menos para Python :) –

Formas alternativas de explorar la aplicación python

Respuesta

Cuestiones relacionadas