python / python/docs-community

Host the Python docs on ReadTheDocs

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

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

discussion
Ngôn ngữ chính
Makefile
Star
55
Fork
26
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

From time to time the discussion arise about moving docs.python.org to readthedocs, there's even an experimental python.readthedocs.io.

I think there's many pros and cons of using readthedocs.

I'd personally be in favor of it if we (the PSF) support them (the cpython Doc is a big one with a lot of traffic, it take around 24h of CPU to build all versions × languages with all PDF A4, PDF letter, HTML, plaintext, epub).

In the other hand it's not an easy task, among other things docs.python.org is not only about generating the docs but also hosting history:

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

Bắt đầu bằng cách xem xét quy trình build và việc lưu trữ hiện tại của docs.python.org, sau đó so sánh với thiết lập thử nghiệm của python.readthedocs.io. Đặc biệt chú ý đến lịch sử phát hành, Python 2.0 và các phiên bản cũ khác, cũng như tải build được nêu đối với nhiều phiên bản, ngôn ngữ và định dạng. Công việc được xem là hoàn tất khi có một kế hoạch di chuyển cụ thể, bảo toàn các yêu cầu đó và giải quyết các đánh đổi giữa PSF và việc lưu trữ.

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.