Skip to content

Conversation

iSOLveIT
Copy link
Collaborator

@iSOLveIT iSOLveIT commented Jun 21, 2025

Changes for issue #122:

  • Removed Data tables and all its dependencies
  • Use GridJS to handle data table integration
  • Fix some testcases
  • Fix data table CSS to support both light and dark modes

Motivation for this change:

Our used DataTables version is quite old (>~4 years) and is still based on jQuery, which was also removed from Sphinx some long time ago.
Also, the JS world has changed, docs get presented in React/Angular/Svelte apps, in which DataTables is causing some problems or at least is adding some unnecessary dependencies (jQuery).
Therefore, this PR cleans up our used JS environment and feels more modern now.

@iSOLveIT iSOLveIT self-assigned this Jun 21, 2025
@iSOLveIT iSOLveIT requested a review from danwos June 25, 2025 09:22
Copy link
Member

@danwos danwos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks already promising.
After building the official docs I found some problems:

  • Pagination works fine, but we need an option how much elements shall be shown: 10, 25, 50, All.
    Otherwise dealing with big tables will not be so comfortable.

  • The sticky head is a nice idea.
    But it is confusing, as the header is transparent so that it shows row data as well:
    image

  • If possible, let's remove the icons, as they may not match a specific theme and their look-alike depends on os/browser:
    image

@danwos
Copy link
Member

danwos commented Jun 26, 2025

Here is a comparison of both.
I guess the following could be changed:

  • No border around the table-element (incl. the buttons)
  • Buttons less prominent: Less rounded corners, a little smaller (size & font)
  • Pagination maybe also without border, or a more transparent border color.

The goal is to have the table data itself quite prominent, but all buttons and co. in a less prominent style.

But that's it, the diffs are already not so much.
Good work.

image
image

@danwos danwos requested a review from chrisjsewell June 26, 2025 06:47
@danwos
Copy link
Member

danwos commented Jun 26, 2025

@chrisjsewell what do you think?
This PR is also some kind of a clean-up, as JS libs are reduced.

@danwos
Copy link
Member

danwos commented Jun 26, 2025

Another finding: Row style seems not to work

image
Source: https://sphinx-needs.readthedocs.io/en/latest/directives/needtable.html#style-row

image
Source: local build via DOCS_THEME=furo sphinx-build -a -E docs docs/_build/html

…ination limit selector, and enhance language settings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants