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

Fix html CI build check

Đang mở
  • Có gì không ổn?
#28 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ó
1/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
35/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python, shell
Lĩnh vực
ci-cd, documentation

Hướng nghiên cứu

Mở build_docs.sh và xác định đối số được truyền cho tên package. Chạy script bằng các giá trị repository và package được nêu trong issue, sau đó xác minh rằng quá trình build tài liệu HTML hoàn tất mà không gặp lỗi package-path.

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

Mô tả

Requested Update

Description
  • The issue arises because the repository and package names are different. Specifically, the repository name is template_basic_plugin while the package name is my_package. One of the build_docs.sh arguments should be my_package but is incorrectly set to template_basic_plugin.
Background and Motivation
  • This is the only repository where this specific failure occurs. Passing the correct package name in the build_docs.sh script will resolve the issue.
Alternative Solutions
  • An alternative fix could involve standardizing the naming convention across all repositories to avoid mismatches between repository and package names.
Environment
  • Repository: template_basic_plugin
  • Package: my_package
Code to demonstrate issue
  • Run the build_docs.sh script and observe the error:
Build html docs
***
GEOIPS_REPO_URL 
GEOIPS_PACKAGES_DIR 
passed path=.
docbasepath=/__w/template_basic_plugin/template_basic_plugin
pkgname=template_basic_plugin
***************************************************************************
ERROR: Package path within repository does not exist:
       /__w/template_basic_plugin/template_basic_plugin/template_basic_plugin
ERROR: Must call with repo path and package name.  Ie
    /packages/geoips/docs/build_docs.sh /geoips geoips [html_only|pdf_only|html_pdf /geoips/docs]
    /packages/geoips/docs/build_docs.sh /data_fusion data_fusion [html_only|pdf_only|html_pdf /geoips/docs]
    /packages/geoips/docs/build_docs.sh /template_basic_plugin my_package [html_only|pdf_only|html_pdf /geoips/docs]
***************************************************************************
Error: Process completed with exit code 1.
Checklist for Completion
  • Update the build_docs.sh script to correctly pass my_package as an argument.
  • Test the script to ensure the documentation builds without errors.
Ngôn ngữ chính
Python
Star
0
Fork
2
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 NRLMMD-GEOIPS/template_basic_plugin

Tất cả issue của NRLMMD-GEOIPS/template_basic_plugin

Issue tương tự

Thêm issue về Python

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.