2012-06-19 37 views
13

Tôi hiện đang viết một số tài liệu mở rộng sử dụng Sphinx cho một trang web Django khá phức tạp. Tôi đã làm việc về điều này trong nhà và trước khi tôi rời khỏi sớm, tôi muốn để lại đằng sau tài liệu chi tiết có thể truy cập bởi các nhà phát triển/quản trị viên mới cho trang web.Lưu trữ tài liệu tư nhân Sphinx

Câu hỏi của tôi là các tùy chọn lưu trữ tài liệu này là gì? Tôi muốn nó được riêng tư. Ngoài ra các tài liệu liên quan đến một trang web không phải là một gói python. Vì hai lý do này, tôi nghĩ rằng Đọc tài liệu có thể không phải là lựa chọn thích hợp nhất.

Tôi đã chạy qua django-sphinxdoc, mặc dù điều này yêu cầu thiết lập Haystack làm chương trình phụ trợ. Có cách nào để chỉ đơn giản là máy chủ tài liệu bằng cách sử dụng tìm kiếm được xây dựng trong js? Hoặc một dịch vụ cho phép lưu trữ riêng tư tài liệu?

Mọi tùy chọn sẽ được đánh giá cao.

Trả lời

14

Nhân sư có thể tạo các tệp tĩnh .html (make html). Đặt các tệp HTML đó lên trên máy chủ web nội bộ và bạn nên làm tốt.

+0

Tính năng này có hoạt động với tìm kiếm js không? –

+2

Yup. Tìm kiếm JS chỉ là JS với một chỉ mục tĩnh (được xây dựng khi bạn xây dựng tài liệu của mình). –

6

Tôi cảm thấy cùng một nhu cầu lưu trữ tài liệu riêng tư. Vì vậy, tôi đã xây dựng một dịch vụ web hỗ trợ tư nhân lưu trữ tài liệu Sphinx: HasDocs.

http://www.hasdocs.com/

Cần loại bỏ sự cần thiết phải thiết lập máy chủ web của riêng bạn, vv Bạn có thể đồng bộ hóa kho và quyền GitHub của bạn. Các dự án riêng tư có tài liệu riêng tư chỉ có thể truy cập được bởi những người có quyền ưu tiên. Tài liệu được xây dựng lại bất cứ khi nào bạn đẩy mã mới vào kho lưu trữ GitHub của bạn.

Phiên bản hiện tại đang trong giai đoạn thử nghiệm và hỗ trợ Sphinx, Jekyll và Javadoc làm trình tạo tài liệu. Xin vui lòng cho nó một thử và bất kỳ thông tin phản hồi sẽ được đánh giá rất nhiều.

+0

Bạn có hỗ trợ bitbucket không? –

+4

Bummed để thấy rằng http://www.hasdocs.com dường như đã biến mất. Bất cứ ai khác có bất kỳ giải pháp tốt cho việc này? –

+0

@BrianKing trông giống như nguồn có sẵn tại [https://github.com/narrowcast/hasdocs.com](https://github.com/narrowcast/hasdocs.com) – Reinbach

-1

Xem câu trả lời cho số này question (tiết lộ đầy đủ, tôi đã đặt câu hỏi, không có câu trả lời đã làm một số nghiên cứu và viết mã và đăng câu trả lời, vì vậy trong khi nó hoạt động ở đó có thể tốt hơn. nếu ai đó sẽ chỉ cho họ.)

repo gitlab này hiển thị ví dụ làm việc here.

Sử dụng static password protection và cũng được thảo luận trong số này issue.

Các vấn đề liên quan