NRLMMD-GEOIPS / NRLMMD-GEOIPS/template_basic_plugin
Fix html CI build check
Open
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_pluginwhile the package name ismy_package. One of thebuild_docs.sharguments should bemy_packagebut is incorrectly set totemplate_basic_plugin.
Background and Motivation
- This is the only repository where this specific failure occurs. Passing the correct package name in the
build_docs.shscript 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.shscript 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.shscript to correctly passmy_packageas an argument. - Test the script to ensure the documentation builds without errors.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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