Как опубликовать мой репозиторий github на readthedocs?

Для тестирования я создал библиотеку на github, адрес доступа: https://github.com/zibuyule/test2.
На readthedocs.org вошел в мою учетную запись github и собрал последнюю версию.
На readthedocs.org мой адрес: https://readthedocs.org/projects/test-zibuyule/.
При нажатии на "прочитать документ" отображается страница ошибки 404. Попробуйте днем ​​еще не решил.
Кто успешно разместил на readthedocs.org, то ли по совету. Я чувствую, что эта вещь все еще очень хороша, надеюсь использовать ее. Спасибо


git read-the-docs
person Wei Yu    schedule 19.03.2016    source источник

Ответы (1)


arrow_upward
1
arrow_downward

Я столкнулся с той же проблемой. Просто поместите файлы документации .md в папку docs вашего репозитория, и все заработает.

Выдержка из их документации:

Сначала мы заглянем внутрь документа или каталога документов, а затем по умолчанию перейдем к верхнему уровню вашей документации.

Кажется, это неверно - папка верхнего уровня не проверяется на наличие .md файлов, поэтому приходится использовать папку docs

person bedrin    schedule 14.05.2016