Image duplication for sphinx docs required

Abierto
#161 0 comentarios 0 reacciones 0 asignados Ver en GitHub

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

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

bug documentation

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

  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 aidotse/PASEOS

Todos los issues de aidotse/PASEOS

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.