Pygithub: Где документация ???

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

Где файлы документации? Я не смог найти их в / doc: https://github.com/PyGithub/PyGithub/tree/master/doc. Им нужно обновление, и я бы с радостью устроил пиар, если бы они были в наличии.

@ericbrandwein Детали документации находятся в самом коде: https://github.com/PyGithub/PyGithub/blob/master/github/Commit.py#L159 -L166

@MichaelPereira, отлично, тогда документация по ReadTheDocs нуждается в обновлении, потому что кнопка «редактировать на github» отправляет меня в каталог /doc в этом репо 😕

Это нормально, потому что здесь находятся введение, оглавление и т. Д., Но расположение документации по коду можно было бы сделать немного более явным.

Но когда я иду сюда: http://pygithub.readthedocs.io/en/latest/apis.html и нажимаю эту кнопку, я попадаю на 404: https://github.com/PyGithub/PyGithub/blob/ мастер / документ / apis.rst

Было бы неплохо, если бы README содержал ссылку на документы.

@gvanrossum Вот и все.

Спрятан на виду. :-(

Это проблема, когда у вас слишком много значков. Я думаю, что документы немного важнее значка, поэтому их обязательно нужно расширить в readme.

В дополнение к README было бы лучше, если бы здесь была добавлена ​​ссылка на документ:

IMHO @gvanrossum и @tmshn на
Фактически, описание в readme.md может быть не чем иным, как ссылкой на правильные документы (поскольку текущее описание содержит только ссылки на очень известные источники.
@jzelinskie , если у вас есть доступ, пожалуйста, подтвердите https://github.com/PyGithub/PyGithub/pull/499 @gamefiend

Закрыл # 499