Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Fix html CI build check

オープン
#28 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
1/5
見積もり時間
1〜3時間
初心者へのやさしさ
35/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
python, shell

調査の方向性

build_docs.sh を開き、パッケージ名として渡されている引数を確認します。Issue に示されているリポジトリとパッケージの値を使ってスクリプトを実行し、package-path エラーなしで HTML ドキュメントのビルドが完了することを確認します。

索引モデルが issue の本文から書いたものです。

説明

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.
主要言語
Python
スター
0
フォーク
2
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

NRLMMD-GEOIPS/template_basic_plugin のほかの issue

NRLMMD-GEOIPS/template_basic_plugin の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。