Skip to content

Render API documentation on the website #626

Open
3 of 3 issues completed
Open

Description

@fsimonis

We should render the API on the website, including bindings:

Language Status Where How
C++ done https://api.precice.org/cpp Doxygen
C done https://api.precice.org/c Doxygen
Fortran (C implementation) done https://api.precice.org/fortran Doxygen as C functions, Fortran module not available
Fortran Module missing Doxygen
Python done https://api.precice.org/python via sphinx (autodoc for cython)
Rust barebone https://api.precice.org/rust forwards to docs.rs via cargo rustdoc
Julia missing documenter.jl
Matlab missing ?

edit: updated the table

Activity

  1. MakisH commented on Nov 5, 2025

    @MakisH
    Member

    Trying to fill the boxes with some additional search:

  2. MakisH commented on Dec 17, 2025

    @MakisH
    Member

    Interesting: The NumPy project seems to be using Breathe to render Doxygen in their Sphinx website: https://www.breathe-doc.org/

    (from an SSE student presentation)

  3. fsimonis commented on Jan 23, 2026

    @fsimonis
    MemberAuthor

    I patched the rust bindings and they now build on docs.rs (automatically picked up).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    technicalTechnical issues on the website

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions