Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Sphinx vs mkdocs?

Đang mở
#7 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.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách đọc trang tiêu chuẩn aind-software-docs được liên kết, sau đó kiểm tra thiết lập tài liệu Sphinx hiện tại của template này và cách lựa chọn mặc định của nó. So sánh thiết lập đó với khuyến nghị MkDocs đã nêu và ghi lại tiêu chuẩn mà template nên tuân theo; issue được hoàn tất khi lựa chọn và định hướng resulting của template được ghi chép rõ ràng.

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

Mô tả

aind-software-docs recommends using mkdocs, should the template conform to that instead of defaulting to sphinx docs?

Ngôn ngữ chính
Jinja
Star
0
Fork
0
Không có pull request nào được merge trong 30 ngày

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.

Issue khác của AllenNeuralDynamics/python-templates

Tất cả issue của AllenNeuralDynamics/python-templates

Issue tương tự

Thêm issue về Documentation

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.