Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Fix html CI build check

Abierto
  • ¿Algo no está bien?
#28 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
1/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
python, shell
Área
ci-cd, documentation

Línea de trabajo

Abre build_docs.sh y localiza el argumento que se pasa para el nombre del paquete. Ejecuta el script usando los valores de repositorio y paquete indicados en el issue y, a continuación, verifica que la compilación de la documentación HTML finalice sin el error package-path.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
Python
Estrellas
0
Forks
2
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de NRLMMD-GEOIPS/template_basic_plugin

Todos los issues de NRLMMD-GEOIPS/template_basic_plugin

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.