Repository navigation
Render API documentation of Python bindings on website #239
Description
The Python bindings are one of the most important ways how users work with preCICE. We spent quite some time to write nice docstrings for the bindings. I would be good if we could integrate this documentation on the website as well. Ideally in such a way that also our search engine sees them.
Maybe a solution could be to first convert them into markdown (maybe via docutils or sphinx, I did not do much research yet) and then include in Jekyll.
Alternatively, we also directly generate html via sphinx, but this is probably not what we want.
Activity
MakisH commentedon Feb 12, 2023
Would be a solution for #165
MakisH commentedon Apr 29, 2024
Discussion:
fsimonis commentedon Oct 30, 2025
I added a minimal rendering using sphinx that can be included into the website similar to how we currently handle Doxygen precice/python-bindings#250
fsimonis commentedon Apr 14, 2026
The rendering has been integrated into the Python bindings and is part of the latest release:
MakisH commentedon Apr 14, 2026
@fsimonis nice! Would it be easy to also add a backlink to precice.org and/or to https://precice.org/couple-your-code-api.html? I can imagine that people will land on that page from a search engine.
fsimonis commentedon Apr 14, 2026
The root already redirects to the api page.
MakisH commentedon Apr 15, 2026
I am not sure what you mean. All the links in this frame point to pages under https://api.precice.org/python/, both for the develop and the latest:
fsimonis commentedon Apr 16, 2026
I see what you mean now. That's an issue for the python-bindings though.