scientific-python / summit-2024

1 stars 0 forks source link

API documentation titles should be monospace #25

Open melissawm opened 1 month ago

melissawm commented 1 month ago

Ideally, this should be an option at the theme level.

Current style is to display using non-monospace font: Captura de imagem_20240603_151447

Suggestion: Captura de imagem_20240603_151621

melissawm commented 1 month ago

May be interesting to explore https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#event-autodoc-process-signature

lagru commented 1 month ago

Ideally, there wouldn't be the redundant repetition of the title and then again the object documentation. I've looked into removing the title altogether in the past. I think the tricky bit was to get the object documentation to appear in the sphinx TOC. But I think there was some work on that in sphinx or at least a feature request?

melissawm commented 1 month ago

Is this what you mean @lagru ?

https://scipy.github.io/devdocs/reference/generated/scipy.interpolate.CloughTocher2DInterpolator.html

melissawm commented 1 month ago

After discussion with @lagru this is a second approach:

Captura de imagem_20240604_172100

Note the absence of page title and reorganization of signature elements.