Image duplication for sphinx docs required
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Área
- build-system, documentation
Línea de trabajo
Empieza comparando las rutas de las imágenes en README.md con los archivos de docs/ y luego ejecuta make html desde la carpeta docs para reproducir las imágenes que faltan. Inspecciona la configuración de la documentación de Sphinx y elige una disposición de rutas o una configuración de búsqueda que evite copias duplicadas de las imágenes; se considera terminado cuando tanto el README de GitHub como la documentación generada localmente o disponible en línea muestran las imágenes correctamente.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Issue
Problem Description
Right now, the images in the readme.md have to also be in the docs folder for the paths to be solved correctly when generating the docs with sphinx.
Expected Behavior
One copy of the images should be fine.
What Needs to be Done
Find some way to make sphinx search the repo root not only the docs folder. or alternative find mutually compatible path where to store the images.
How Can It Be Tested or Reproduced
Look at readme on github and docs online or locally via make html in the docs folder.
- Lenguaje dominante
- Python
- Estrellas
- 64
- Forks
- 16
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una plantilla de pull request
- Sin guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de aidotse/PASEOS
-
bug enhancement good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
-
Sensor AnomaliesAbiertoenhancement example
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
-
enhancement user-facing visualization
Dificultad 4/5 3-5 días Aptitud para principiantes 30/100
-
feature
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
Todos los issues de aidotse/PASEOS
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
Deltares/numba_celltree#100 · 1 comentario ·
-
auto-reported bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 63/100
Los mantenedores suelen responder en 1 día
-
soup airgap-bundle --bundle-size-cap nan, inf or a cap above ~1.67e299 GiB stops with an internal ValueError/OverflowError (exit 1) instead of a usage errorPosiblemente ocupada @Keshemir la tomó hoy. Abiertobug claimed difficulty:2
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
MakazhanAlpamys/Soup#3045 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
dagster-io/skills#80 ·
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 1 día