ynput / ynput/ayon-python-api

Investigate ReadTheDocs to ease documentation readability

Đang mở
#180 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

documentation
Ngôn ngữ chính
Python
Star
16
Fork
15
Merge trung bình
1 ngày 9 giờ
Pull request đã merge (30 ngày)
10

Mô tả

Is there an existing issue for this?
  • I have searched the existing issues.
Please describe the feature you have in mind and explain what the current shortcomings are?

This work needs to be approved first.
From a discussion with @dee-ynput and @mkolar it looks like readthedocs (theme and/or platform) might be beneficial for the automated API docs generated through Sphinx.

This could be investigated to assess the benefit/concerns.

How would you imagine the implementation of the feature?

No precise idea yet, it could be simply use the ReadTheDocs theme with sphinx or bringing more in order to get versioning feature automatically there for free.
We need to see if everything can remain on GitHub pages in order to not multiplying the host platforms tho..

Are there any labels you wish to add?
  • I have added the relevant labels to the enhancement request.
Describe alternatives you've considered:

No response

Additional context:

No response

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

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Không có tệp hoặc kiểm thử nào được nêu tên. Hãy bắt đầu bằng việc xem xét cách tài liệu API do Sphinx tạo ra hiện được xuất bản trên GitHub Pages, sau đó tìm hiểu theme và nền tảng ReadTheDocs, bao gồm các đánh đổi về versioning và hosting; công việc được xem là hoàn tất khi đã ghi lại các lợi ích, mối quan ngại và một khuyến nghị để phê duyệt.

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
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
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.