Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Field list display different in Sphinx 2 #855

Closed
jonashaag opened this issue Nov 6, 2019 · 5 comments · Fixed by #838
Closed

Field list display different in Sphinx 2 #855

jonashaag opened this issue Nov 6, 2019 · 5 comments · Fixed by #838
Labels
Needed: design decision A core team decision is required

Comments

@jonashaag
Copy link

Sphinx 1:
Screenshot 2019-11-06 at 15 30 45

Sphinx 2:
Screenshot 2019-11-06 at 15 30 40

This is not fixed with #838

@agjohnson
Copy link
Collaborator

agjohnson commented Nov 7, 2019

We likely won't aim for parity here initially. The styles with the html4 writer use a table display. With the html5 writer, the output is a definition list. Because there is no wrapper element, such as a <tr> or <div>, in a definition list "row", the solution to this is going to be doing some gross stuff with flex.

@agjohnson agjohnson added the Needed: design decision A core team decision is required label Nov 7, 2019
@xdev-x
Copy link

xdev-x commented Nov 14, 2019

In my opinion, the render with Sphinx 1 is much more concise and nice to read.

@agjohnson
Copy link
Collaborator

Yup, I agree. There's a lot of undue aversion to tables in modern HTML, but unfortunately, this seems like it was pretty obvious case for tables to begin with.

hugobuddel added a commit to hugobuddel/sphinx_rtd_theme that referenced this issue Feb 28, 2020
See readthedocs#855, so people like me are not confused.
@cjw296
Copy link

cjw296 commented Jun 2, 2020

@agjohnson - we're now on Sphinx 3, right?

I'm not sure I follow why this issue is marked as done, here's 0.4.3:
https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/lists_tables.html#field-list

Here's master:
https://sphinx-rtd-theme.readthedocs.io/en/latest/demo/lists_tables.html#field-list

What am I missing?

@hugobuddel
Copy link

hugobuddel commented Jun 4, 2020

The master version of the fieldlist is about twice as high than in was 0.4.3. With more than 1200 pixels it doesn't even fit on my laptop screen. Having to scroll up and down makes the information significantly harder to interpret, especially when comparing multiple of such field sets next to each other.

Arguably option lists (#801) look better, but field lists certainly do not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: design decision A core team decision is required
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants