lnoor/sphinx-jsonschema

📐 Hiển thị JSON Schema trong tài liệu Sphinx dễ dàng

Một tiện ích mở rộng Sphinx nhỏ gọn giúp render JSON Schema thành HTML một cách trực quan.

sphinx-jsonschema là một extension cho Sphinx cho phép bạn nhúng và hiển thị các JSON Schema trong tài liệu. Dự án được tạo ra từ nhu cầu cá nhân của tác giả và hỗ trợ phần lớn tính năng của JSON Schema Draft 4, kèm theo một số tiện ích mở rộng riêng.

✨ Điểm nổi bật

• Hỗ trợ đầy đủ JSON Schema Draft 4: gần như toàn bộ tính năng của bản nhất định nghĩa.
• Nhiều nguồn schema: hỗ trợ schema nội tuyến, tệp cục bộ, URL từ xa và đối tượng Python.
• JSON Pointer: chọn phần schema con từ nguồn bên ngoài bằng ký pháp #/path/to/schema.
• Tham chiếu liên kết: sử dụng $ref và $$target để tạo liên kết nội bộ giữa các schema.
• reStructuredText trong chuỗi: cho phép dùng markup RST trong title và description.
• Hỗ trợ YAML và JSON: đọc schema từ cả hai định dạng.
• Từ khóa examples: hỗ trợ thêm từ Draft 7.
• Mở rộng $$description: cho phép mô tả dưới dạng mảng chuỗi để dễ đọc hơn.

💡 Vì sao đáng chú ý

Không giống các công cụ render schema chung chung, sphinx-jsonschema được thiết kế riêng cho hệ sinh thái Sphinx, tích hợp trực tiếp qua directive jsonschema. Điều này giúp tài liệu API hoặc spec kỹ thuật trở nên sinh động và dễ bảo trì hơn. Ngoài ra, việc hỗ trợ cả schema nội tuyến lẫn ngoại tại giúp linh hoạt trong mọi trường hợp sử dụng.

---

#JSONSchema #Sphinx #Python #Documentation #OpenSource #TiniX