Okydoky là một người xây dựng tài liệu tự động sử dụng Sphinx, phân phối và GitHub (là setuptools) & nbsp; Nó làm cho dự án đóng Python của bạn để tiếp tục xây dựng các tài liệu, với các giả định sau đây.:
1. Tài liệu được thực hiện bằng cách sử dụng Sphinx.
2. Dự án được đóng gói thông qua setuptools (không pip và cũng không có những người khác).
3. Mã nguồn được quản lý theo GitHub.
Để nói ngay, nó chỉ đơn giản là một ReadTheDocs.org cho sử dụng cá nhân.
Làm thế nào nó hoạt động
Nó hoạt động trong các hướng dẫn sau đây:
1. Khi cam kết mới được đẩy, GitHub gây Okydoky hậu nhận móc.
2. tải Okydoky tarball lưu trữ các cam kết đẩy từ GitHub.
3. Tarball lưu trữ được chiết xuất vào một thư mục tạm thời.
4. Sphinx xây dựng các tài liệu hướng dẫn.
5. Khi người dùng yêu cầu các tài liệu sử dụng trình duyệt web của họ, Okydoky yêu cầu người dùng xác thực bằng GitHub OAuth.
6. Nếu họ có các quyền, Okydoky phục vụ một tài liệu được xây dựng.
Làm thế nào để sử dụng
Đây là một gói Python thường. Bạn có thể cài đặt nó bằng cách sử easy_install:
& Nbsp; easy_install Okydoky
Gói này cung cấp một kịch bản dòng lệnh gọi okydoky. Nó là một ứng dụng web và cũng có một máy chủ web nhỏ cho chính nó. Phải mất một tập tin cấu hình.
Tập tin cấu hình có chứa một số giá trị cần thiết như phím ứng dụng GitHub và khóa bí mật.
Bạn có để tạo ra một ứng dụng để sử dụng GitHub Okydoky. Callback URL của nó là rất quan trọng. Điền nó với:
http: //
và thay thế
http: //
Nếu bạn tạo một tập tin cấu hình, sau đó chạy một máy chủ bằng cách sử dụng kịch bản Okydoky okydoky:
& Nbsp; -H okydoky 0.0.0.0 -p 8080 yourconfig.py
Cuối cùng, bạn phải thực hiện một auth ban đầu để kết thúc cài đặt. Mở http: //
Cấu hình
Các tập tin cấu hình là một kịch bản Python bình thường. Nó sử dụng hệ thống cấu hình của Flask. Đọc tài liệu Flask về file config.
Kho
& Nbsp; Tên người dùng và kho ví dụ 'Crosspop / okydoky'.
CLIENT_ID
& Nbsp; khách hàng trọng điểm của ứng dụng GitHub.
CLIENT_SECRET
& Nbsp; khóa bí mật của ứng dụng GitHub.
SAVE_DIRECTORY
& Nbsp; Các đường dẫn của thư mục để lưu trữ dữ liệu. Thư mục này sẽ lưu trữ một số dữ liệu, tarball, các tài liệu và xây dựng cấu hình.
SECRET_KEY
& Nbsp; Các khóa bí mật ký phiên. Xem tài liệu Flask về phiên cũng.
Mã nguồn mở
Okydoky được viết bởi Hồng Minhee cho Crosspop. Nó được phân phối theo giấy phép MIT, và mã nguồn có thể được tìm thấy trong kho GitHub. Kiểm tra:
& Nbsp; git clone git: //github.com/crosspop/okydoky.git
là gì mới trong phiên bản này:
- GitHub buộc nhà nước cho OAuth. Làm theo đó.
là gì mới trong phiên bản 0.9.4:
- Sử dụng tùy chọn --upgrade cho setup.py phát triển lệnh. Điều này ngăn cản xung đột phiên bản phụ thuộc.
- Xây dựng các bản ghi còn lại trong tập tin build.txt.
là gì mới trong phiên bản 0.9.3:
- Bây giờ các trang index cho thấy danh sách của refs.
- Bây giờ bộ Okydoky OKYDOKY = 1 biến môi trường trong quá trình xây dựng của nó. [# 5]
- Add / head url ref đặc biệt.
- Cố định một lỗi mà người đứng đầu không được thiết lập đến mới nhất cam kết.
là gì mới trong phiên bản 0.9.2:
- Cố định một lỗi bảo mật: bây giờ người dùng phải có một ủy quyền cho các kho lưu trữ. [# 4]
Yêu cầu :
- Python
Bình luận không