precice / precice/python-bindings
Sphinx documentation: No backlink to the main project
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Cython
- Sterne
- 30
- Forks
- 19
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Überprüfe die Sphinx-Dokumentationskonfiguration für die Python-Bindings, insbesondere die Einrichtung der Seitenleiste, und überprüfe das Layout der generierten Seite. Die Arbeit ist abgeschlossen, wenn die Dokumentation einen Rückverweis auf https://precice.org/couple-your-code-api.html enthält und der Link in der Seitenleiste oder einer gleichwertigen Navigation sichtbar ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 68/100