aws / aws/aws-encryption-sdk-python

sphinx is not rendering enum members

Đang mở
#162 3 bình luận 0 reaction 0 người được giao Xem trên GitHub
good first issue maintenance
Ngôn ngữ chính
Python
Star
255
Fork
92
Merge trung bình
2 ngày 17 giờ
Pull request đã merge (30 ngày)
2

Mô tả

This worked originally; at some point it changed.

https://github.com/sphinx-doc/sphinx/issues/1609

I tried just slotting this into our auto-generated tree, but it looks like this will only work once we re-structure the docs to be better organized and less reliant on "just auto-generate everything and dump it in a big pile".

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu bằng việc xem xét issue #1609 của Sphinx được liên kết và cây tài liệu được tự động tạo của repository. Xác định các thành viên enum được kỳ vọng xuất hiện ở đâu và liệu cấu trúc tài liệu hiện tại có thể hỗ trợ thay đổi này hay không; hoàn thành có nghĩa là các thành viên enum được render chính xác mà không phụ thuộc vào một dump được tạo thiếu cấu trúc.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
documentation
Loại issue
Lỗi
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.