Pygithub: ¿Dónde está la documentación ???

http://pygithub.readthedocs.io/en/latest/introduction.html

¿Dónde están los archivos de documentación? No pude encontrarlos en / doc: https://github.com/PyGithub/PyGithub/tree/master/doc. Necesitan una actualización, y con mucho gusto haría un PR si estuvieran disponibles

@ericbrandwein Los detalles de la documentación están en el código mismo: https://github.com/PyGithub/PyGithub/blob/master/github/Commit.py#L159 -L166

@MichaelPereira oh genial, entonces la documentación sobre ReadTheDocs necesita una actualización, porque el botón "editar en github" me envía al directorio /doc en este repositorio 😕

Lo cual está bien porque aquí es donde se encuentran la introducción, la tabla de contenido, etc., pero la ubicación de la documentación del código podría hacerse un poco más explícita

Pero cuando voy aquí: http://pygithub.readthedocs.io/en/latest/apis.html , y hago clic en ese botón, me lleva a un 404: https://github.com/PyGithub/PyGithub/blob/ master / doc / apis.rst

Sería bueno si el archivo README contuviera un enlace a los documentos.

@gvanrossum Ahí tienes.

Oculto a la vista. :-(

Ese es el problema cuando tienes demasiadas insignias. Creo que los documentos son un poco más importantes que una insignia, por lo que definitivamente debería ampliarse más en el archivo Léame.

Además del README, sería mejor si el enlace al documento se agregara aquí:

En mi humilde opinión, @tmshn dan en el clavo.
De hecho, la descripción en readme.md podría ser nada más que el enlace a los documentos correctos (porque la descripción actual solo contiene enlaces a fuentes muy conocidas.
@jzelinskie , si tiene acceso, apruebe el https://github.com/PyGithub/PyGithub/pull/499 de @gamefiend

Cerrado por # 499