precice / precice.github.io

The website of preCICE
https://precice.org/
12 stars 56 forks source link

Render API documentation of Python bindings on website #239

Open uekerman opened 1 year ago

uekerman commented 1 year ago

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.

MakisH commented 1 year ago

Would be a solution for #165

MakisH commented 3 months ago

Discussion: