Added style to table representation

[germa89]

Hi there

Since we would like to use Pandas DataFrame to present data in PyMAPDL documentation, I thought we might as well include the style in the Pyansys Theme.

The proposal is shown as this:

I'm happy to do any changes you might propose. I just tried the colors align with Ansys color theme.

[germa89]

Slightly improved version:

Notes

This affects any table in the documentation (see for example tech demo in User guide > Extended examples). It looks super good in my opinion, specially for big tables.

The issue is it ALSO affects autosummary (not sure why).

This is not a good effect.

Proposal

I wonder if someone more skilled than me can sort out how to create a table style in CSS which is only applied to Dataframes.
I believe by default the style for dataframes is something like Dataframe table or similar (please check this). If it is like that, we should just over write that style in our ansys.css.

I did a bit of research and I didn't find the way to do this. However, if requested I can keep trying.

[Andy-Grigg]

These changes are nice! I like the colors and the highlighting.

I'm seeing some slight weirdness with building the docs for an as-yet-unreleased package I'm working on, I'll follow up with you separately on what I'm seeing there.

I am by no means a css expert, but I've added some comments that I think should help limit the changes to affect dataframes only.

[germa89]

Final proposal:

• The general style (colouring) is common to tables, dataframes and longtable.
  

• Tables do not have hovers.
  

• Dataframes and longtable do have hovers.
  

• autosummary tables have all their rows white and do have hovers (the rest of the format is inherited from table)
  

[Andy-Grigg]

I have added a few more comments. I like what you've done with the comments and adding in specific sections for different types of tables, it's a bit more verbose but I think it's the right way to go.

I have only tested the dataframe table type, because that's the only one our docs are currently using. I'll have to rely on you or Alex to test out some of the other table types you have added to the CSS.

[akaszynski]

I have only tested the dataframe table type, because that's the only one our docs are currently using. I'll have to rely on you or Alex to test out some of the other table types you have added to the CSS.

I typically use sphinx tables and pandas.DataFrame, so we're going to have to test out the other styles as we go.

I think these tables look excellent. Nice work @germa89 (and by extension, @RomanIlchenko1308 who I think helped inspire this work with VM examples).

[germa89]

I typically use sphinx tables and pandas.DataFrame, so we're going to have to test out the other styles as we go.

In PyMAPDL you can find:

• Tables: https://dev.mapdldocs.pyansys.com/user_guide/mapdl.html#unsupported-interactive-commands
• Long tables: https://dev.mapdldocs.pyansys.com/user_guide/mapdl.html#table-1
• Plain Dataframes: vm8 (when merged) https://mapdldocs.pyansys.com/examples/06-verif-manual/vm-008-parametric_calculation.html#sphx-glr-examples-06-verif-manual-vm-008-parametric-calculation-py
• and Formatted Dataframes: https://dev.mapdldocs.pyansys.com/examples/06-verif-manual/vm-007-plastic_compression_of_a_pipe_assembly.html#sphx-glr-examples-06-verif-manual-vm-007-plastic-compression-of-a-pipe-assembly-py

If this theme modification is successful I guess we will get rid of formatted dataframes, in favour of plain dataframes which will inherit the settings (colors, etc) from the theme.

I think disregarding the coloring issue with the dataframe odd rows, we are good to go.

[Andy-Grigg]

Thank you @germa89, the changes look good! I ran a build of the Granta docs based on this branch, and the dataframe outputs look great. Good to merge.

[RomanIlchenko1308]

Hi @germa89 and @Andy-Grigg,

At first, I would like to thank you guys for your work, it looks nice!!!

I am writing this comment because, I have accidentally discovered weird behavior of the highlighting the rows when you select some rows in the data frame on the Non-available Commands it is not an issue, but, it looks weird a bit for me:

that we have a connectivity (highlighting selections) of the first row and the index column with column, as you can see below:

But, if you move your mouse down, we have just a partial hover selection of the columns but without indexing column as you can see it below:

And if you are going to zoom away and see how it looks like, you can see it below:

My question:
Can we make the table in the same style ?

If I am wrong, please write me)
thank you in advance @germa89 and @Andy-Grigg !!!

[Andy-Grigg]

Hi @RomanIlchenko1308!

I think the issue is caused by the merged rows, and I'm not really sure what the best option is to fix it. The first column is taking the color of the row that it starts on. The same thing is happening when it highlights as well.

I don't think there's much we can do to make the first column highlight correctly, because the CSS can only ever highlight a cell all the same color. I think all we can do is not highlight tables with merged cells, but I don't know if that's possible. @germa89, any thoughts?

[germa89]

We could create a class for non-highlighted tables if needed, so we leave it at the writer if he wants that behavior or not.

Other than that, I do not think I can fill the color issue. It is way beyond my expertise. I could try, but the amount of time required vs reward, it is very low.

I would leave it as it is. Or if @RomanIlchenko1308 wants to implement the non-highlighted class, I'm happy to review them.