fix: increase margins of autosummary tables

[12rambau]

Fix #1553

I decided to double it from the initial value to make it more prominent. @betatim is it sufficient for your needs ?

[betatim]

I looked through some pages like https://pydata-sphinx-theme--1560.org.readthedocs.build/en/1560/api/pydata_sphinx_theme/toctree/index.html to get a feeling for the change. It looks good to me and more obvious where one method ends and the next one starts.

[trallard]

@smeragoel could you have a look at this?
As this pertains to UI changes affecting flow/whitespace you might have insights

[smeragoel]

Could we also decrease the vertical space between the text in the methods (marked in red) and increase the vertical space between the methods more? I think that will make it easier to visually differentiate the methods.

This is what I suggest:

I did a quick mockup in Figma, but I can also provide exact values for the spacing if needed

[betatim]

I like having more whitespace :)

Maybe we can keep a different amount of spacing between lines of the same paragraph and paragraphs?

[12rambau]

I'm on the more white space team here. This example is a very small documentation line but for bigger API the use of multiple paragraphs can save your eyes and compressing them make them visually invisible.

Look at the "notes" from scipy FFT method: https://docs.scipy.org/doc/scipy/reference/generated/scipy.fft.fft.html#scipy.fft.fft

In addition, keep in mind that the first line is the short description of the function it's completely independent from the other paragraphs.

[drammock]

Could we also decrease the vertical space between the text in the methods (marked in red)

I don't object to a slight decrease there, but I agree with @betatim and @12rambau that the amount shown in the mock-up reduced it too much, to where it's hard to tell when new paragraphs start.

[smeragoel]

Got it, I'll work on a new mockup which has better paragraph spacing

[12rambau]

for references, the current split is 1rem, If we want to reduce it, I can play with it until I find a satisfying value.

[smeragoel]

What if we reduce the paragraph spacing to 24 px and increase the spacing between the methods to 48 px? It's not a huge change from the current preview build, but it compounds just enough to make it all look cleaner.

[drammock]

What if we reduce the paragraph spacing to 24 px and increase the spacing between the methods to 48 px? It's not a huge change from the current preview build, but it compounds just enough to make it all look cleaner.

🤷🏻 I think we need to see it to know for sure.

[12rambau]

Nothing is set in pixels in the theme but in rem. The current spacing for paragraph is a very standard 1 rem that I would like to keep consistent across the theme texts. my last commit vastly increase the methode spacing to 3rem.

THe pre-build bug due to the scipy website bug, I'll relaunch it once they solve it: scipy/docs.scipy.org#80

[trallard]

Nothing is set in pixels in the theme but in rem. The current spacing for paragraph is a very standard 1 rem that I would like to keep consistent across the theme texts. my last commit vastly increase the methode spacing to 3rem.

This is something that might need a more in-depth review, too. Especially as we continue to do accessibility work (i.e. this might impact WACAG Success Criteria 1.4.4 Resize Text and 1.4.10 Reflow).
While it is best not to use pixels for font sizes this does not apply for other circumstances such as margins and spacing (see https://ashleemboyer.com/blog/why-you-should-use-px-units-for-margin-padding-and-other-spacing-techniques)

[12rambau]

the last build worked, let me know what you think about the last iteration:
https://pydata-sphinx-theme--1560.org.readthedocs.build/en/1560/api/pydata_sphinx_theme/toctree/index.html

[drammock]

the last build worked, let me know what you think about the last iteration: https://pydata-sphinx-theme--1560.org.readthedocs.build/en/1560/api/pydata_sphinx_theme/toctree/index.html

works for me. The between-method spacing is slightly on the too-large side for my tastes, but it's a matter of taste, not a blocker or a request for changes.

[betatim]

The latest rendering looks good to me. This is purely from a aesthetic point of view, you should listen to someone who knows about accessibility for a judgement on that.

[12rambau]

then Ill wait for @smeragoel feedback before doing anything

[smeragoel]

LGTM!

[betatim]

Thanks everyone for the work!

[12rambau]

I'll make a patch release this WE