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

Standardisation of sphinx docs page titles

Aperta
#232 14 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Ambito
build-system, documentation

Direzione di ricerca

Esamina prima la pagina di esempio all’indirizzo https://diamondlightsource.github.io/python-copier-template/main/how-to.html e la discussione dell’issue, poiché non sono indicati file sorgente o test. Conferma che il progetto abbia concordato una convenzione per i titoli e individua il punto di ingresso della build della documentazione prima di definire l’ambito di un controllo; l’attività è completata quando la convenzione è esplicita e la build la applica in modo coerente.

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

Descrizione

enhancement

This may be the nitpickiest issue I have ever raised, so should not be actioned unless there's strong agreement.

Image
(from https://diamondlightsource.github.io/python-copier-template/main/how-to.html)

It annoys me that the titles for docs pages are not really standardised, Some Are Capitalised, some are not, some are prefixed with "How to" or similar. If there is a really easy check that can be added to the docs builds it might add a layer of consistency and professionalism. The hardest part, as ever when we talk about formatting, may be agreeing on which standard to use.

Lingua principale
Jinja
Stelle
25
Fork
10
Merge medio
4g 17h
PR unite (30g)
7

Guida per i contributori

Apri la 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 DiamondLightSource/python-copier-template

Tutte le issue di DiamondLightSource/python-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.