precice / precice/python-bindings
Sphinx documentation: No backlink to the main project
Nessuno ha ancora preso questa issue.
- Lingua principale
- Cython
- Stelle
- 30
- Fork
- 19
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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:
Diverged from #239
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
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.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 68/100