python / python/mypy

[docs]: The "Edit Page" button is not visible in the documentation for the stable branch.

Aperta
#17,947 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation
Lingua principale
Python
Stelle
20.6k
Fork
3.3k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

Documentation

while fixing issue #17870 , I opened the PR #17933 , after the merge of that PR, I noticed the following behavior:


When we view the latest branch, the "Edit" button is visible. This happens because Sphinx uses the GitHub repository link combined with the branch name to allow editing the specific source file of the documentation.

Screenshot 2024-10-15 at 2 24 58 AM


However, when we switch to the stable branch, the "Edit" button disappears. This is expected behavior with Sphinx since the stable docs are released using tags, and tagged releases aren't associated with branches that can be directly edited.

Screenshot 2024-10-15 at 2 25 06 AM


Screenshot 2024-10-15 at 2 53 42 AM


IMO, we need to further discuss whether this is the behavior we want or if we need to consider changing how we deploy our docs.

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.

Direzione di ricerca

Non viene indicato alcun file, test o punto di ingresso. Inizia esaminando la configurazione di deployment della documentazione Sphinx per i branch latest e stable, quindi determina se la documentazione contrassegnata come stable debba esporre un percorso di modifica. Il lavoro è completato quando sono stati concordati il comportamento e l’ambito di implementazione documentato.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.