7
Tiêu đề nói lên tất cả. Những gì tôi tưởng tượng là có docstrings cho tất cả các mô-đun, lớp học và chức năng của tôi và bằng cách nào đó độc đáo điều hướng doc thông qua github (wiki?). Ngoài ra, tài liệu phải được đồng bộ hóa với mã mới nhất có nghĩa là nó phải được cập nhật/tái tạo khi đẩy. Điều đó có thể không?Tự động tạo tài liệu GitHub Wiki từ Python Docstrings
Sphinx chắc chắn là nó, mặc dù nó sử dụng restructuredText hơn Markdown. Đối với Markdown, có mkdocs, nhưng điều đó không hỗ trợ docstrings. Mặc dù, tôi đã bắt đầu thử nghiệm này (có thể là một ý tưởng tồi): https://github.com/waylan/mddoc – Waylan
Tôi đã có cùng một vấn đề ([readme.md] (https://github.com/matteoferla/ mutagenesis)) và tôi không tin rằng có một câu trả lời hay. Tôi đã thử mkdocs —just bị ô nhiễm thư mục của tôi— và [pydoc_markdown] (https://github.com/NiklasRosenstein/pydoc-markdown), hit Google hàng đầu, trong đó đã đưa ra một phần nhỏ của pydoc văn bản đã cho. Cuối cùng tôi chỉ đơn giản là có đầu ra pydoc và thực hiện ba hoặc bốn tìm kiếm và thay thế một vài mục. –
Chúng tôi nhận thấy rằng Github per-repo wikis không liên quan đến cam kết repo chính, có nghĩa là nếu bạn muốn tài liệu chính xác cho mỗi cam kết (để mọi cam kết được kiểm tra có tài liệu phù hợp), repo wiki là vô ích. –