Okydoky

Okydoky jest zautomatyzowany budowniczy dokumentacji za pomocą Sphinx, Dystrybucja i GitHub (co było setuptools) & nbsp; To sprawia, że ​​zamknięty projekt Pythona do ciągłego budowania dokumentacji, przy następujących założeniach.:
1. Dokumentacja jest wykonywane przy użyciu Sphinx.
2. Projekt jest pakowany przez setuptools (nie pip ani żadnych innych).
3. Kod źródłowy jest zarządzane GitHub.
Powiedzieć krótko, jest to po prostu ReadTheDocs.org do użytku prywatnego.
Jak to działa?
To działa w następujących instrukcji:
1. Gdy nowe rewizje są wypychane, GitHub wyzwala Okydoky po otrzymywać hak.
2. Okydoky pliki do pobrania paczkę tar archiwa pchane zatwierdzeń z GitHub.
3. tarballa dostaje ekstrakcji archiwum do katalogu tymczasowego.
4. Sfinks buduje dokumentacji.
5. Gdy użytkownicy zażądać dokumentów za pomocą swojej przeglądarki internetowej, Okydoky prosi użytkownika do uwierzytelniania za pomocą GitHub OAuth.
6. Jeśli ma zezwolenie, Okydoky służy wbudowany docs.
Jak używać
To zwykły pakiet Pythona. Można ją zainstalować za pomocą easy_install:
& Nbsp; easy_install Okydoky
Pakiet ten zawiera skrypt, nazywany okydoky. Jest to aplikacja internetowa, a także mały serwer www dla siebie. To zajmuje plik konfiguracyjny.
Pliki konfiguracyjne muszą zawierać pewne wymagane wartości, takie jak klucz aplikacji GitHub i tajnego klucza.
Musisz utworzyć aplikację GitHub do korzystania Okydoky. Jego zwrotny adres URL jest bardzo ważne. Wypełnij go:
http: // / auth / finalizuje
i zastępuje z nazwą domeny, co można wykorzystać. A potem, dodać post-otrzymałeś hak do repozytorium GitHub:
http: // /
Jeśli się plik konfiguracyjny, a następnie uruchomić serwer Okydoky pomocą okydoky skrypt:
& Nbsp; okydoky H 0.0.0.0 -p 8080 yourconfig.py
Wreszcie, trzeba dokonać wstępnego uwierzytelniania, aby zakończyć instalację. Otwórz http: // / w swojej przeglądarce internetowej i zalogować się z GitHub stamtąd.
Konfiguracja
Jest plik konfiguracyjny skrypt Pythona normalne. Używa systemu config kolby znajduje. Przeczytaj o docs kolby w plikach konfiguracyjnych.
REPOZYTORIUM
& Nbsp; nazwa użytkownika i repozytorium np "Crosspop / okydoky".
Client_id
& Nbsp; kluczowym klientem aplikacja GitHub jest.
CLIENT_SECRET
& Nbsp; tajny klucz aplikacji GitHub jest.
SAVE_DIRECTORY
& Nbsp; ścieżka do katalogu do przechowywania danych. Ten katalog będzie przechowywać kilka skonfigurowanych danych, archiwów i zbudowane dokumentacje.
SECRET_KEY
& Nbsp; tajny klucz do podpisania sesje. Zobacz docs kolby za około sesji również.
Open source
Okydoky jest napisany przez Hong Minhee dla Crosspop. Jest rozpowszechniany na licencji MIT, a kod źródłowy można znaleźć w repozytorium GitHub. Sprawdź:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git

Co nowego w tym wydaniu:

• GitHub zmuszony stan dla OAuth. Śledź tego.

Co nowego w wersji 0.9.4:

• Użyj opcji --upgrade dla setup.py rozwijać polecenie. To zapobiega konfliktom wersji zależności.
• Zbuduj dzienniki są w lewo w pliku build.txt.

Co nowego w wersji 0.9.3:

• Teraz strona Strona wyświetla listę literatury.
• Teraz Okydoky zestawy OKYDOKY = zmienną 1 środowiskiem podczas procesu kompilacji. [# 5]
• Dodaj / head specjalnym sędzią url.
• Naprawiono błąd, że głowica nie jest ustawiona na ostatni commit.

Co nowego w wersji 0.9.2:

• Naprawiono błąd bezpieczeństwa: teraz użytkownicy muszą mieć Zezwolenie na repozytorium. [4]

Wymagania :

• Python