2011-08-19 22 views
8

tôi đã tự hỏi nếu có bất kỳ lựa chọn thay thế tốt để Sphinx khi tôi muốn cung cấp tài liệu html tĩnh cho các dự án phần mềm. Nhân sư có vẻ ok nhưng chủ yếu được sử dụng trong khu vực Python. Tôi quan tâm đến một giải pháp có khả năng có thể được sử dụng trong tất cả các loại dự án không chỉ liên quan đến Python.Bất kỳ lựa chọn thay thế tốt nào cho Nhân sư để cung cấp tài liệu phần mềm?

Mục tiêu của tôi là để ghi lại nội dung trong markdown hoặc một cái gì đó như thế và sau đó tạo ra một trang web html tĩnh sẽ được chuyển giao cho người sử dụng (quản trị viên)

Tôi cũng đã thấy Gollum nhưng điều này được gắn với GitHub :(

Trả lời

5

Bạn có nghĩ rằng đó là một vấn đề lớn mà Sphinx chủ yếu được sử dụng trong vùng Python? Đúng là Sphinx được viết bằng Python và chủ yếu hướng tới tài liệu Python. Nhưng IMHO, một trong những điểm mạnh là nó có thể

Nhân sư sẽ cho phép bạn thực hiện chính xác những gì bạn hỏi: "tài liệu công cụ trong markdown hoặc một cái gì đó như thế và sau đó tạo ra một trang web html tĩnh ". Nhân sư sử dụng , đó là "hoặc một cái gì đó như thế" bit.

Nếu bạn muốn thử một chút khác biệt, tôi sẽ đề xuất .

+1

Có rất nhiều lỗi trong sphinx và nó là một nhức đầu như vậy để làm cho nó chạy mà tôi tốt hơn sử dụng cái gì khác mà dành 3 ngày chiến đấu với các lỗi nhập khẩu và đường dẫn hệ thống. – minerals

3

Bạn có thể muốn xem xét tặng Gollum một giao diện khác. Tôi sẽ đề cập đến những suy nghĩ của tôi về Gollum vì nhu cầu âm thanh của tôi tương tự như yêu cầu của bạn. Tôi đã bắt đầu sử dụng Gollum gần đây cho tài liệu dự án Rails và kinh nghiệm của tôi cho đến nay là rất tích cực. Nó được phát triển bởi những người ở Github nhưng nó không gắn với dịch vụ Github và có thể được sử dụng độc lập với Github.

Đây là một dự án nguồn mở rất tích cực với nhiều người đóng góp. Khung là Sinatra và bạn có thể dễ dàng chạy nó trên máy trạm cá nhân của bạn. Tôi giữ một máy chủ Gollum chạy trên máy phát triển của tôi và chỉnh sửa trực tiếp các tệp Markdown và sau đó xem kết quả trong máy chủ Gollum cục bộ. Điều này đặc biệt tốt nếu bạn thiết lập trình soạn thảo của mình để tự động thêm các cập nhật của bạn bằng một phím tắt. Khi bạn đã sẵn sàng, bạn có thể tạo một trang html tĩnh dạng wiki Gollum của mình bằng cách sử dụng dự án this.

Ngoài ra, vì nó sử dụng git đằng sau hậu trường nên được xây dựng trong phiên bản và tất cả sức mạnh của git.

+2

Liên kết trong thư của bạn đề cập đến kho lưu trữ không được dùng nữa, vui lòng sử dụng https://github.com/gollum/gollum thay thế. – ClementNerma

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