Okydoky

Okydoky представляет собой автоматизированную строитель документация помощи Сфинкс, распространять и GitHub (который был Setuptools) и NBSP; Это делает ваш проект закрыт Python постоянно строить документации, при следующих допущениях.:
1. Документация делается с помощью Сфинкса.
2. Проект упакованы через Setuptools (не пип ни какие-либо другие).
3. Исходный код управляется при GitHub.
Сказать, в ближайшее время, это просто ReadTheDocs.org для частного использования.
Как это работает
Он работает в следующих инструкциях:
1. Когда новые коммиты толкнул, GitHub вызывает Okydoky после получать крюк.
2. Okydoky загрузок архив архивы толкнул фиксаций из GitHub.
3. архив Архив получает извлечены во временный каталог.
4. Сфинкс строит документации.
5. Когда пользователи запрашивают документацию, используя их веб-браузер, Okydoky просит пользователя для проверки подлинности с помощью GitHub OAuth.
6. Если они есть разрешение, Okydoky служит встроенный документы.
Как использовать
Это обычный пакет Python. Вы можете установить его с помощью easy_install:
& NBSP; easy_install Okydoky
Этот пакет предоставляет сценарий командной строки под названием okydoky. Это веб-приложение, а также небольшой веб-сервер для себя. Это займет конфигурационный файл.
Config файлы должны содержать некоторые необходимые значения, как GitHub ключа приложения и секретного ключа.
Вы должны создать приложение, чтобы использовать GitHub Okydoky. Его Обратный адрес является очень важным. Залейте его:
HTTP: // <хост> / авт / финализации
и заменяет <хост> с именем домена, что вы будете использовать. А потом, добавить пост-крюк получить в вашем хранилище GitHub:
HTTP: // <хост> /
Если вы конфигурационный файл, а затем запустить в Okydoky сервер, используя okydoky сценарий:
& NBSP; okydoky -H -p 8080 0.0.0.0 yourconfig.py
Наконец, вы должны сделать первоначальный авторизацию, чтобы закончить установку. Открыть HTTP: // <хост> / в веб-браузере и войдите с GitHub оттуда.
Конфигурация
Файл конфигурации является нормальным скрипт на Python. Он использует систему конфигурационный колбу в. Читайте документы колбу идет о конфигурационных файлах.
СКЛАД
& NBSP; имя пользователя и хранилище, например "crosspop / okydoky.
CLIENT_ID
& NBSP; ключ клиента приложения GitHub в.
Client_secret
& NBSP; секретный ключ приложения GitHub в.
SAVE_DIRECTORY
& NBSP; Путь к каталогу для хранения данных. Этот каталог будет хранить некоторые настроенные данных, архивы и встроенные документации.
СЕКРЕТНЫЙ КЛЮЧ
& NBSP; Секретный ключ, чтобы подписать сессий. См документы колбу идет о сессиях также.
Open Source
Okydoky написана Hong Minhee для Crosspop. Она распространяется под лицензией MIT, и исходный код можно найти в репозитории GitHub в. Проверять, выписываться:
& NBSP; мерзавец клон Git: //github.com/crosspop/okydoky.git

Что нового В этом выпуске:

• GitHub вынужден состояние для OAuth. Следуйте этим.

Что нового в версии 0.9.4:

• Использование --upgrade вариант для setup.py разработки Команда. Это предотвращает конфликты версий зависимостей.
• Построить журналы остаются в файле build.txt.

Что нового в версии 0.9.3:

• Теперь страница Индекс показывает список работах.
• Теперь Okydoky наборы OKYDOKY = переменную окружения 1 в процессе его сборки. [# 5]
• Добавить / голова особое ссылка гиперссылка.
• Исправлена ​​ошибка, что голова не установлен в последний коммит.

Что нового в версии 0.9.2:

• Исправлена ​​ошибка безопасности: теперь пользователи должны иметь Разрешение на хранилище. [# 4]

Требования

• Python