NRLMMD-GEOIPS / NRLMMD-GEOIPS/template_basic_plugin

Fix html CI build check

Open
#28 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
1
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open build_docs.sh and locate the argument passed for the package name. Run the script using the repository and package values shown in the issue, then verify that the HTML documentation build completes without the package-path error.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, shell
Domain
ci-cd, documentation
Issue type
Bug
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.