intersphinx/sphinx-hoverref

Offen
#82 6 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
30/100
Issue-Typ
Feature
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
jupyter, jupyter-notebook
Bereich
documentation

Rechercherichtung

Start by reviewing the Jupyter Book configuration linked in the issue and compare sphinx-hoverref with sphinx-codeautolink for xarray documentation links. Determine whether either approach works without making notebooks too messy; done means a chosen approach is integrated and provides easier, more robust links.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

dependencies enhancement

For easier and more robust links to the xarray documentation.

Jupyter Book uses it in their own docs, so it is definitely possible. I guess the downside is that the notebook would look more messy in Jupyter. But maybe sphinx-codeautolink would work, at least for the code blocks.

Vorherrschende Sprache
Jupyter Notebook
Sterne
204
Forks
121
Keine gemergten PRs in 30 T.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus xarray-contrib/xarray-tutorial

Alle Issues in xarray-contrib/xarray-tutorial

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.