Image duplication for sphinx docs required

Aperta
#161 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma

Direzione di ricerca

Inizia confrontando i percorsi delle immagini in README.md con i file sotto docs/, quindi esegui make html dalla cartella docs per riprodurre le immagini mancanti. Esamina la configurazione della documentazione Sphinx e scegli una disposizione dei percorsi o una configurazione di ricerca che eviti copie duplicate delle immagini; il lavoro è completato quando sia il README di GitHub sia la documentazione generata localmente o disponibile online visualizzano correttamente le immagini.

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

Descrizione

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.

Lingua principale
Python
Stelle
64
Fork
16
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

  • Include un Dockerfile o un file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

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

Tutte le issue di aidotse/PASEOS

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.