API documentation rendering issues in readthedocs

[Stephanie Chong]

API documentation rendering in readthedocs

Rendering issues I have noticed have included:

• Formulae either not rendering at all, or not rendering properly
• Dot points not rendering properly
• Grey boxes appearing on subsequent lines following a dot point (I suspect caused by using tabs on subsequent lines following a dot point).

I have previously fixed a few things I noticed (non-rendering formulae in the API docs for quantile loss, additive bias, multiplicative bias and mean error). However, aside from the things that jumped out at me, I don't have the requisite background to assess whether the API documentation is rendering properly in readthedocs.

I wanted to raise the issue, in case someone else wants to look through the API documentation in readthedocs to assess for any other rendering issues.

[Tennessee Leeuwenburg]

Thank you very much for helping raise the profile of these improvement opportunities :) We have collectively now gone through these issues in much more detail. Many of them have been resolved, are the subject of open merge requests (should be fixed shortly), or have more specific issues tracking them. This issue was a helpful prompt issue, but I would now prefer if we could move to using more specific issues to track any remaining defects that are discovered. I am going to close this issue now, but please feel free to re-open it if you disagree with the approach.