DOC consistent objective description

[tomMoral]

There is several issue with the description of the objective in each benchmark:

• The latex equations are not rendered in the README.rst
• We need to maintain them at several places (benchmark README, list of objective in the doc, it would be nice to include in benchmark result page, ...)

A potential solution would be to have a small file objective.rst in the benchmark folder that describe the objective. We could include it when generating the doc, and use sphinx to convert it to HTML for the results and the README.

This requires significant developments effort so it is clearly not a priority.

[agramfort]

that would not fix

• The latex equations are not rendered in the README.rst

right?

[tomMoral]

We could generate images or HTML and include these rendered equations in the README.rst.

[agramfort]

With a ci? Do you know any repo doing something similar?

[tomMoral]

No I don't but I did not look a lot around. that is why it is simply a proposal 😅

I am also open to other suggestions.

Le sam. 4 déc. 2021 à 17:52, Alexandre Gramfort @.***> a écrit :

With a ci? Do you know any repo doing something similar?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/benchopt/benchopt/issues/259#issuecomment-986057408, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAZKZ6MYDGHB4XC4H6JQ7TTUPJBOJANCNFSM5JLJF7YA .

[mathurinm]

This only fixed half of the issue, but the objectives in readme are now properly rendered.