[mkdocs] Add github action that tests the build of the example pages
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 18.8k
- Fork
- 2.8k
- Merge medio
- 16h 26m
- PR unite (30g)
- 21
Descrizione
Right now we build the examples from jupyter notebooks here
https://github.com/plotly/plotly.py/blob/main/.circleci/config.yml#L356-L388
If any notebook outputs an error the build fails and the docs won't publish
We need to implement something similar for the new docs so we don't end up showing failures on published pages
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia leggendo i passaggi di build del notebook in .circleci/config.yml alle righe 356-388 e confrontali con il nuovo build della pagina di esempio MkDocs. Definisci il check di GitHub Actions in modo che gli errori nell'output del notebook facciano fallire il build prima della pubblicazione della documentazione; il lavoro è completato quando il workflow rileva questi errori.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- github-actions, jupyter-notebook, python
- Ambito
- build-system, ci-cd, documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 42/100