Improve Documentation VII

[zm711]

So in this documentation improvement I did:

1. My usual search for typo fixes/minor clarifications
2. I rearranged the sorters docs to move the internal sorters above the legacy sorters because as a reader once I reach legacy I would likely stop reading the docs rather than read on to see SC2 and Tridesclous2, so it is better to be proud of the internal products and move them above legacy. I also added install instruction for Tridesclous2 so for people that want to test it out they can
3. I deleted the legacy section of widgets documentation and instead moved/made sure that every widget currently exposed in the widgets_list.py is connected to in the docs. My question for that is: I added matplotlib backend, but do all widgets now all have at least the ipy backend as well
4. I actually went through the examples for the modules gallery to fix typos and try to add clarifications and keyword arguments

[alejoe91]

Thank you so much Zach!!! This is great :)

No not all widgets have a ipy backend yet. For example:

• plot_all_amplitudes_distributions
• plot_crosscorrelograms
• plot_agreement_scores

The available backends are correctly listed in the API references: https://spikeinterface.readthedocs.io/en/latest/api.html#spikeinterface.widgets.plot_all_amplitudes_distributions

[zm711]

Of course :)

The available backends are correctly listed in the API references:
https://spikeinterface.readthedocs.io/en/latest/api.html#spikeinterface.widgets.plot_all_amplitudes_distributions

Cool, I'll update the backend part of the docs soon.

I wanted to update this because I constantly go to that section of the docs to remember the exact name of the plotting function I want (for example the name change from multicomp to multicomparison etc).

[alejoe91]

Of course :)

The available backends are correctly listed in the API references:
https://spikeinterface.readthedocs.io/en/latest/api.html#spikeinterface.widgets.plot_all_amplitudes_distributions

Cool, I'll update the backend part of the docs soon.

I wanted to update this because I constantly go to that section of the docs to remember the exact name of the plotting function I want (for example the name change from multicomp to multicomparison etc).

@zm711 since you're at it, could you remove the Legacy part of the widgets API (https://spikeinterface--2229.org.readthedocs.build/en/2229/api.html#legacy-widgets) and check if all plot_functions are listed there?

List of plot functions

API entries

Thanks!!!

[zm711]

Yep. I can do that as well. It's a holiday coming up here so it might not happen this week, but I'll put it on my todo list.

[alejoe91]

No rush! I can also try to add them if you're ok with me pushing here :)

[zm711]

No rush! I can also try to add them if you're ok with me pushing here :)

Of course. Always.

[zm711]

Just one note if you do push changes, just watch out editing core because I didn't build this on top of my new import docs with core edited so I'm hoping to avoid merge conflicts... (I know you were just planning on looking at api.rst, but just as a warning).

[alejoe91]

Done and also fixed some other sphinx warnings and missing refs :)

[alejoe91]

nice catch!

[alejoe91]

For context, this was generating a missing reference and I couldn't find a way to ref a dynamically generated sphinx-gallery module, but just individual files.

[zm711]

A lot of the sphinx gallery stuff is annoying like that, but based on my reading they don't really have plans to try to patch things like that. Such is life I suppose.

[zm711]

Couple more typos while we are at it.