Просмотр .rst на сайте github Pages

Я перемещаю документацию по проекту с открытым исходным кодом на Github Pages, но застрял на перемещении файлов .rst.

У нас есть ReadMe.rst, который вы можете увидеть здесь в коде. Я хотел бы создать ссылку на эту страницу с нашей главной страницы документации, но GitHub не отображает .rst как HTML. поэтому браузер просто загружает текст файла .rst, когда вы нажимаете ссылку).

Конечно, есть инструменты для рендеринга .rst как HTML, но это серьезный дополнительный шаг. Мы начали использовать .rst исключительно потому, что GitHub автоматически отображает его на кодовых страницах. Вы могли подумать, что есть способ получить этот автоматический рендеринг для страниц Github ...


person Tom Swirly    schedule 25.02.2013    source источник
comment
Вы что-нибудь нашли? Я столкнулся с той же проблемой   -  person dmeu    schedule 07.06.2013
comment
Нет, к сожалению, мы отказались от этого. :-( Сообщите нам здесь, если у вас есть какие-либо результаты.   -  person Tom Swirly    schedule 08.06.2013
comment
@TomSwirly Следуя вашим ссылкам, похоже, вы решили использовать sphinx для рендеринга ваших файлов README.rst. Это именно то решение, которое я выбрал для одного из моих репозиториев. (Еще не реализовано.)   -  person Louis    schedule 30.10.2013
comment
@ Louis-DominiqueDubeau - да, на самом деле все получилось неплохо. Проект все еще номинально находится в стадии бета-тестирования, но на самом деле он довольно зрелый и в некоторой степени используется, поэтому я думаю, что кто-то читает эту документацию ...   -  person Tom Swirly    schedule 31.10.2013


Ответы (2)


GitHub Pages не поддерживает .rst / RestructuredText. Он поддерживает только преобразование Markdown и Textile в HTML.

person parkr    schedule 03.08.2014

GitHub Pages не поддерживает напрямую reStructuredText, но Энн Джентл создала отличную демонстрацию того, как можно заставить что-то работать с помощью достаточно простых шагов:

https://github.com/annegentle/create-demo

Особенно полезно посмотреть на рабочий процесс github, чтобы узнать, как автоматически генерировать необходимый HTML из источников reStructuredText при каждой фиксации.

person Epcylon    schedule 10.03.2021