Skip to content

Render API documentation of Python bindings on website #239

@uekerman

Description

@uekerman

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    technicalTechnical issues on the website

    Type

    No type

    Projects

    Status

    Mid

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions