Doc formatting is broken in various places/ways

[cluhmann]

The list of methods for the MMM module is squashed horizontally. Many methods have long names, but I am not sure this is the problem. I am viewing on a desktop with a widescreen, so I don't think it's a resolution/aspect ratio issue either. Here is a screenshot of the delayed_saturated_mmm module found here:

In addition, some of the MMM methods have docstrings that I suspect are incorrectly formatted. Here is an example of the documentation of the channel_contributions_forward_pass() method. The return values are formatted correctly, but the arguments (channel_data) are not:

The same problems occur with get_channel_contributions_forward_pass_grid().

[wd60622]

Yes, I've noticed this too in a spots. Usually fixed by adding a space the docstring in order to separate the sections better. There might be a way to check and/or format automatically

[OriolAbril]

Sphinx prints a lot of warnings when building the docs. They are about that and indicate where are blank lines or indents missing mostly.

[wd60622]

Running list:

BaseMMM

• [ ] BaseMMM.compute_channel_contribution_original_scale
• [ ] BaseMMM.get_target_transformer
• [ ] BaseMMM.plot_channel_contribution_share_hdi
• [ ] BaseMMM.plot_channel_parameter
• [ ] BaseMMM.plot_component_contributions
• [ ] BaseMMM.plot_prior_predictive

MMM

The ones from above plus some more

• [ ] MMM.compute_channel_contgribution_original_scale
• [ ] MMM.get_target_transformer
• [ ] MMM.plot_channel_contribution_share_hdi
• [ ] MMM.plot_channel_parameter
• [ ] MMM.plot_component_contributions
• [ ] MMM.plot_prior_predictive
• [ ] MMM.validate_channel_columns
• [ ] MMM.validate_date_col
• [ ] MMM.validate_target

[wd60622]

@juanitorduz You may have hit many of these when doing the ruff checks