Okydoky

Okydoky є автоматизована будівельник документації з використанням Sphinx, поширювати і GitHub (який був Setuptools) і NBSP; Це робить ваш Проект закритий Python постійно будувати документації, з урахуванням наступних припущень .:
1. Документація здійснюється за допомогою Sphinx.
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. Це веб-додаток, а також невеликий веб-сервер для себе. Це займе конфігураційний файл.
Файли конфігурації повинні містити деякі необхідні значення, як GitHub ключ додатків і секретного ключа.
Ви повинні створити додаток GitHub використовувати Okydoky. Його Зворотній дзвінок URL є дуже важливим. Залийте його:
HTTP: // <хост> / авт / Завершення
і замінює <хост> з доменним ім'ям, що ви будете використовувати. А потім, додати пост-отримувати гак у вашому сховищі GitHub:
HTTP: // <хост> /
Якщо ви зробите конфігураційний файл, а потім запустити в Okydoky сервер, використовуючи okydoky скрипт:
І NBSP; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
Нарешті, ви повинні зробити початковий авторизацію, щоб закінчити установку. Відкрити HTTP: // <хост> / у веб-браузері і увійдіть з GitHub звідти.
Конфігурація
Файл настройок є звичайним шрифтом Python. Він використовує систему конфігурації колбу в. Читайте документацію колбу йде про конфігураційних файлах.
СКЛАД
І NBSP; ім'я користувача та сховище, наприклад, "Crosspop / okydoky.
CLIENT_ID
І NBSP; ключ клієнта додатки GitHub-х років.
Client_secret
І NBSP; секретний ключ додатки GitHub-х років.
SAVE_DIRECTORY
І NBSP; шлях до каталогу для зберігання даних. Цей каталог буде зберігати деякі налаштовані даних, архіви, і вбудовані документації.
Secret_key
І NBSP; секретний ключ, щоб підписати сесій. См документи колбу йде про сесіях також.
Open Source
Okydoky написаний Hong Minhee для Crosspop. Це поширюється під ліцензією MIT, і вихідний код можна знайти в репозиторії GitHub. Оформити замовлення:
І NBSP; Git клон 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