Tự động xuất bản tài liệu sinh ra nhân sư trên wiki bitbucket?

Question

Tôi có gói python với tài liệu do nhân tạo tạo ra (sử dụng tính năng tự động hóa) và nó có thể được tạo thành một tập hợp các trang html tĩnh nằm trong thư mục _build trong kho git của dự án. Tôi muốn xem tài liệu này theo cách khá đẹp và riêng tư cách về bitbucket. Có vẻ như wiki mà là một repo git chính nó có thể được sử dụng cho điều đó.

Có một bước đơn giản nào có thể tạo/chuyển đổi tài liệu html của tôi thành đánh dấu và đẩy nó vào kho lưu trữ bitbucket wiki không?

Answer 1

Thật không may này là không thực sự tốt ...

Bạn có thể đẩy dir _build của bạn vào repo wiki và tạo liên kết trong wiki (Home.rst) vào file html của bạn như sau:

`Sphinx docs <_build/html/index.html>`_ 

Và nó sẽ hiển thị chúng nhưng bao gồm của css/js _static sẽ không hoạt động, vì vậy tài liệu của bạn sẽ trông xấu xí :(

bạn cũng có thể publish your docs as a website on BitBucket nhưng không có sự riêng tư, tài liệu của bạn sẽ được công khai ngay cả khi repo của bạn là riêng tư, vì vậy đây không phải là rất hữu ích, n bạn chỉ có thể đi với read the docs ...

Đọc tài liệu thực sự supports privacy để bạn có thể thêm tài liệu của mình ở chế độ riêng tư và thêm Webhook trong BitBucket. Rất tiếc, điều này chỉ hoạt động với repos công cộng, do đó, không phải là giải pháp tuyệt vời ...

P.S. Có một ứng dụng có thể tái sử dụng cho phép bạn phục vụ riêng tư tài liệu nhân sư của bạn từ django (được bảo vệ): django-docs;) Và bạn có thể xây dựng những tài liệu đó từ các tệp * .rst của bạn ...