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

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

Спасибо.

Ответы

Ответ 1

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

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

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

Ответ 2

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

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

Ответ 3

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

paver gh_pages_create gh_pages_build

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