Sphinx documentation: No backlink to the main project

Aperta Adatta ai principianti
#258 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Esamina la configurazione della documentazione Sphinx per i binding Python, in particolare la configurazione della barra laterale, e controlla il layout della pagina generata. Il lavoro è completato quando la documentazione include un backlink a https://precice.org/couple-your-code-api.html e il link è visibile nella barra laterale o in una navigazione equivalente.

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

Descrizione

documentation

In the Sphinx documentation, there is no backlink to the preCICE website. That would be useful for people landing directly to the Python bindings documentation from a search engine, for example.

I think that adding something in the sidebar, for example, would be good. It could link to https://precice.org/couple-your-code-api.html

Current view:

Image

Diverged from #239

Lingua principale
Cython
Stelle
30
Fork
19
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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 precice/python-bindings

Tutte le issue di precice/python-bindings

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.