Sphinx documentation: No backlink to the main project
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
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.
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
- Dominant language
- Cython
- Stars
- 30
- Forks
- 19
- PR merge metrics
- No merged PRs in 30d
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.
More from precice/python-bindings
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
precice/python-bindings#175 · 2 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
precice/python-bindings#255 ·
-
good first issue
Difficulty 3/5 1-2 days Newbie friendliness 68/100
precice/python-bindings#248 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 38/100
precice/python-bindings#238 · 6 comments ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
precice/python-bindings#209 ·
All issues in precice/python-bindings
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
palladius/rails8-app-on-gcp#145 ·
-
NeedsTriage
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
error Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
textual definition
Difficulty 1/5 Under an hour Newbie friendliness 90/100
geneontology/go-ontology#32653 ·