precice / precice/python-bindings
Sphinx documentation: No backlink to the main project
Nobody has claimed this yet.
- Dominant language
- Cython
- Stars
- 30
- Forks
- 19
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect the Sphinx documentation configuration for the Python bindings, especially the sidebar setup, and review the generated page layout. The work is done when the documentation includes a backlink to https://precice.org/couple-your-code-api.html and the link is visible in the sidebar or equivalent navigation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100