Pygithub: Où est la documentation ???

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

Où sont les fichiers de documentation ? Je ne les ai pas trouvés dans /doc : https://github.com/PyGithub/PyGithub/tree/master/doc. Ils ont besoin d'une mise à jour, et je ferais volontiers un PR s'ils étaient disponibles

@ericbrandwein Le détail de la documentation se trouve dans le code lui-même : https://github.com/PyGithub/PyGithub/blob/master/github/Commit.py#L159 -L166

@MichaelPereira oh super, alors la documentation sur ReadTheDocs a besoin d'une mise à jour, car le bouton "modifier sur github" m'envoie dans le répertoire /doc de ce référentiel 😕

Ce qui est bien car c'est là que se trouvent l'introduction, la table des matières, etc., mais l'emplacement de la documentation du code pourrait être un peu plus explicite

Mais quand je vais ici : http://pygithub.readthedocs.io/en/latest/apis.html , et que je clique sur ce bouton, cela m'amène à un 404 : https://github.com/PyGithub/PyGithub/blob/ master/doc/apis.rst

Ce serait bien si le README contenait un lien vers la doc.

@gvanrossum Voilà.

Caché à la vue de tous. :-(

C'est le problème quand vous avez trop de badges. Je pense que la documentation est un peu plus importante qu'un badge, donc cela devrait certainement être développé davantage dans le fichier readme.

En plus du README, ce serait plus sympa si le lien vers la doc est ajouté ici :

IMHO @gvanrossum et @tmshn sont sur place.
En fait, la description dans le readme.md pourrait n'être rien de plus que le lien vers les bons documents. (car la description actuelle ne contient que des liens vers des sources très connues.
@jzelinskie , si vous avez l'accès, veuillez approuver @gamefiend 's https://github.com/PyGithub/PyGithub/pull/499

Fermé par #499