Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Fix html CI build check

Aperta
  • Qualcosa non va?
#28 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
python, shell
Ambito
ci-cd, documentation

Direzione di ricerca

Apri build_docs.sh e individua l'argomento passato per il nome del package. Esegui lo script usando i valori del repository e del package indicati nell'issue, quindi verifica che la build della documentazione HTML venga completata senza l'errore package-path.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.
Lingua principale
Python
Stelle
0
Fork
2
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NRLMMD-GEOIPS/template_basic_plugin

Tutte le issue di NRLMMD-GEOIPS/template_basic_plugin

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.