lincc-frameworks / lincc-frameworks/python-project-template

Cleaner left-hand table-of-contents for API reference

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

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

Ngôn ngữ chính
Jinja
Star
85
Fork
16
Merge trung bình
6 giờ 18 phút
Pull request đã merge (30 ngày)
1

Mô tả

Looking at the HATS RTD, the menu options in the left-hand-side for the API reference have a lot of unnecessary duplication:

API reference
└── hats
    ├── hats.catalog
    ├── hats.inspection
    └── ...

I would really love if we could have it be simpler:

hats API reference
├── catalog
├── inspection
└── ... 

this includes the package name in the top-level, and omits the package name from the submodule names.

I don't even know if sphinx/autoapi supports this, but I can dream, right?

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 xác định cấu hình Sphinx/AutoAPI tạo tài liệu tham chiếu API trong tài liệu Read the Docs. Kiểm tra xem các tùy chọn của cấu hình có thể tạo tên gói cấp cao nhất được yêu cầu và các nhãn mô-đun con ngắn hơn hay không. Được xem là hoàn tất khi phần điều hướng bên trái đã kết xuất hiển thị “hats API reference” với các mục như “catalog” và “inspection”, không lặp lại tên gói.

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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
38/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.