Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Build release docs with local package

Aperta
#38 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
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python

Direzione di ricerca

Inizia individuando il workflow di rilascio che pubblica il pacchetto su PyPI e poi crea la documentazione della release. Confronta la creazione della documentazione dal wheel caricato con quella direttamente dal codice sorgente e verifica che il workflow non attenda più PyPI, completando comunque con successo la build della documentazione.

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

Descrizione

Currently, we first publish a package to PyPI and then use that to build the docs for a release. This has the disadvantage that the workflow needs to wait for the package to become available. This not only takes some time and has the potential to time out but it also limits parallelism. But it has the advantage that it tests whether the package was actually published.

However, I think that the last point is not relevant as it effectively tests the 3rd party publish action that we use.
Instead, for our Python-only packages, we can buld the docs wither with a wheel that was uploaded as an artefact or simply from source. Building a wheel only takes a few seconds.

Lingua principale
Jinja
Stelle
2
Fork
2
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 scipp/copier_template

Tutte le issue di scipp/copier_template

Issue simili

Altre issue su Build System

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.