Как загрузить HTML-документацию, созданную из sphinx, на github?

Question

Я только что задокументировал загрузки своего кода и узнал, как использовать sphinx для генерации документации. Я хочу включить это в свою страницу проекта github, но я не знаю, как это сделать. Кто-нибудь знает существующий учебник или простой шаг для этого?

Спасибо.

Answer 1

github предоставит вам статический контент, используя функцию github pages . По сути, вы создаете ветку под названием gh-pages, в которую вы фиксируете свои статические страницы. Затем страницы обслуживаются на you.github.com/yourproject.

См. Инструкции на http://pages.github.com/.

Вероятно, вы столкнетесь с проблемой использования Sphinx на github, потому что Sphinx использует каталоги с ведущими символами подчеркивания. Вы можете исправить это, добавив файл с именем .nojekyll в каталог с созданным sphinx html.

Answer 2

Ответ Джона Полетта , очевидно, является правильным и, вероятно, достаточным для большинства пользователей (+1).

В качестве альтернативы вы можете обратиться к подробному учебнику Бена Уэлша Документация Sphinx по GitHub , который содержит пошаговые инструкции, а также удобный скрипт / задачу на основе Fabric , связывающие их вместе. чтобы вы начали Быстрая публикация документации вместе с вашим кодом [...] с помощью одной команды.

Answer 3

github-tools имеет функцию, которая делает именно то, что вы просите:

paver gh_pages_create gh_pages_build

Обратитесь к превосходной документации (конечно, используя себя) для того, чтобы настроить его для своего проекта.