Intersphinx links to related docs esp. API pages

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

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Start with the intersphinx configuration in docs/source/conf.py at the linked lines, then search the documentation for references and links to NumPy, matplotlib, cartopy, and other related libraries. Convert external documentation references to intersphinx links; the work is done when the relevant references are converted and the docs build successfully.

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

Descrizione

docs

In 25288ba I set up docs external project linking using the intersphinx Sphinx extension:

https://github.com/NCAS-CMS/cf-plot/blob/ad190e2748d2cbec9906d4c7c992e8a5e34f3da5/docs/source/conf.py#L59-L63

but apart from one case I haven't gone through the docs to convert any references and links to other related libraries and dependencies e.g. NumPy, matplotlib, cartopy, etc. These should be searched for and converted, then going forward any reference to external docs should be linked via intersphinx means rather than as a standard RST link.

Lingua principale
Python
Stelle
21
Fork
11
Merge medio
2g 8h
PR unite (30g)
9

Preparare l'ambiente

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 NCAS-CMS/cf-plot

Tutte le issue di NCAS-CMS/cf-plot

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.