Rewrite Tick formatters example

[timhoffm]

• Collect all relevant descriptions in the summary text at the top
• Merge everything into one figure. The code should be mostly irrelevant for the example. The figure can serve as a standalone reference.

Also closes 25967 by deleting the "Dollar ticks" example. [Deferred]

[story645]

Since it's all getting combined and the code doesn't matter, is there anyway to loop over the arguments so that the titles have to stay in sync w/ the code?

[timhoffm]

Since it's all getting combined and the code doesn't matter, is there anyway to loop over the arguments so that the titles have to stay in sync w/ the code?

I don't think so. While https://matplotlib.org/stable/gallery/ticks/date_formatters_locators.html does something like that, the special code for FuncFormatter and FixedFormatter make it difficult here.

I'm not at all worried about "stay in sync". This will hardly change and the title and formatter code are always in neighboring lines.

[timhoffm]

New example: https://output.circle-artifacts.com/output/job/7e5ea6a8-7123-4505-9742-353df3e7644a/artifacts/0/doc/build/html/gallery/ticks/tick-formatters.html#sphx-glr-gallery-ticks-tick-formatters-py

[story645]

My own bias, but can you put the figure before the code since the code isn't the important part?

[timhoffm]

AFAIK this is not possible in sphinx-gallery. What I would like even more would be an option to collapse code blocks in sphinx-gallery, but that's also not supported.

[rcomer]

According to this page, if there is only one code block the image appears before the code.
https://sphinx-gallery.github.io/stable/auto_examples/plot_1_exp.html#sphx-glr-auto-examples-plot-1-exp-py

I am not clear how it is counting more than one code block for the current case 😕

[timhoffm]

Likely it counts:

• Title, description
• Code
  Which works here: https://matplotlib.org/devdocs/gallery/text_labels_and_annotations/fancytextbox_demo.html#sphx-glr-gallery-text-labels-and-annotations-fancytextbox-demo-py

In this example we have the References text block after the code. Likely that prevents the reordering, which makes sense because it would bring two description blocks together that we have written separately.

should I move this up? If so, I would reduce it to the set-*-formatter references. The references section is mainly there to generate the backreferences mini-galleries. This is anyway not happening on the formatter classes and not important for the other functions mentioned.

[story645]

should I move this up? If so, I would reduce it to the set-*-formatter references.

I think you can probably drop it here since that's more or less what you're frontloading with the text. I think having a more prominent figure should be the priority since that's kinda the important part of this example (as an aside/out of scope here though, maybe the figure should go into the ticker docs since it's a reference for the formatters and same for the locators)

[rcomer]

I think the reference section is no longer needed to generate the mini-galleries. For example plt.rcdefaults's gallery shows two examples that do not have the explicit reference list. These days the functions within the code work as clickable links, so maybe it gets it from that?

[timhoffm]

It depends. Sphinx-gallery cannot infer all objects. For example, ax0.xaxis.set_major_formatter is linked, but axs2[0].xaxis.set_major_formatter is not. Luckily, we here have links for all relevant functions in the code, so the references section can indeed go.

[timhoffm]

The references section is gone.

I've additionally removed the "Dollar ticks" example (closes #25967). The formatting is more concisely explained in this overview. We don't need individual examples for all the formatters.

[rcomer]

The dollar ticks example is included here:

matplotlib/galleries/tutorials/artists.py

Lines 719 to 725 in 5f29763

	# Here is an example which sets the formatter for the right side ticks with
	# dollar signs and colors them green on the right side of the yaxis.
	#
	#
	# .. include:: ../gallery/ticks/dollar_ticks.rst
	# :start-after: .. redirect-from:: /gallery/pyplots/dollar_ticks
	# :end-before: .. admonition:: References

[timhoffm]

I've restored the dollar ticks example. Let's handle this in another PR.

[story645]

Suggested change

	See :ref:`formatters` for a complete list.
	See :ref:`formatters` for a complete list.

Take or leave unindenting this so that this is a bit more prominent. Can self merge

[timhoffm]

The list is a list of formatters. So indentation is correct IMHO