Manual needs to correct tables because it affects the displays on mobile devices #100721

New Issue

Hoang Duy Tran · 2022-08-30T23:13:02+02:00

Hoang Duy Tran commented

2022-08-30 23:13:02 +02:00

System Information
Operating system:
Graphics card:

Blender Version
Short description of errors

The above image shown the weakness of the Table designs where the title section takes so much space and left nearly nothing for the content parts. I’m willing to take up this task to correct all RST files if it is agreed by bug schedulers

**System Information** Operating system: Graphics card: **Blender Version** **Short description of errors** ![130F3F4E-06E6-445A-9DC9-3A3B01C71749.png](https://archive.blender.org/developer/F13438156/130F3F4E-06E6-445A-9DC9-3A3B01C71749.png) The above image shown the weakness of the Table designs where the title section takes so much space and left nearly nothing for the content parts. I’m willing to take up this task to correct all RST files if it is agreed by bug schedulers

Hoang Duy Tran commented

2022-08-30 23:13:02 +02:00

Added subscriber: @hoanguk

Pratik Borhade commented

2022-08-31 04:40:53 +02:00

Added subscriber: @PratikPB2123

Aaron Carlisle commented

2022-08-31 18:20:16 +02:00

Added subscriber: @Blendify

Aaron Carlisle commented

2022-08-31 18:20:16 +02:00

Can you share the link to the the webpage in your screenshot?

Aaron Carlisle commented

2022-08-31 18:20:30 +02:00

Changed status from 'Needs Triage' to: 'Needs User Info'

Hoang Duy Tran commented

2022-08-31 21:56:43 +02:00

There are many pages with this problem. The above page is at

https://docs.blender.org/manual/en/dev/editors/image/image_settings.html
https://docs.blender.org/manual/vi/3.4/editors/3dview/display/overlays.html
(
this repeats over many pages

: ../../editors/3dview/display/overlays.rst
: ../../editors/dope_sheet/introduction.rst:75
: ../../editors/outliner/interface.rst:148 ../../editors/uv/selecting.rst:139
: ../../files/blend/rename.rst ../../files/import_export/grease_pencil_pdf.rst
: ../../files/import_export/grease_pencil_svg.rst
: ../../grease_pencil/properties/onion_skinning.rst
: ../../modeling/curves/selecting.rst:112
: ../../modeling/meshes/editing/mesh/sort_elements.rst:32
: ../../modeling/meshes/selecting/checker_deselect.rst:24
: ../../modeling/meshes/selecting/linked.rst:75

: ../../modeling/surfaces/selecting.rst:100

)

https://docs.blender.org/manual/vi/3.4/editors/image/introduction.html
(This repeats:

: ../../editors/image/introduction.rst:78 ../../editors/uv/introduction.rst
: ../../editors/video_sequencer/preview/header.rst:69
)

This page really affects the render of the page on desktop browsers, due to the inclusion of images and wraparound texts:

https://docs.blender.org/manual/en/dev/editors/graph_editor/fcurves/properties.html

This table format, however, appeared OK on mobile devices:

https://docs.blender.org/manual/vi/3.4/editors/3dview/modes.html

However, this page is also very imbalance on mobile devices, due to the keyboard, don't know how to avoid it:

https://docs.blender.org/manual/vi/3.4/editors/3dview/navigate/walk_fly.html

I haven't gone right through the whole Blender manual tree, so I cannot locate all instances, but those are problems on mobile device, such as iPhone I'm using. I don't know how the layout (css and javascript) is designed for mobile devices, but I know they are separate from desktop version. So may be the problem is not from the source end, but from the web-page layout ends. I am speculating here of course, so please investigate thoroughly before approach to fix the problem.

I took a little digging around and it turned out to be the

:param1:

  text describe param1

render as

param1: text describe param1

                <wrapped round at the edge of where the 'text' started so leaving the whole section for param1 blank, like a tabular format>

I personally think this format is VERY limited, including on the Desktop browsers, and should be avoided as much as possible.

I think we could try the table format for those instead :

.. _tab-view3d-modes:

.. list-table:: Blender's Modes

 :header-rows: 0
 :class: valign
 :widths: 30 60

Best regards,
Hoang Tran

There are many pages with this problem. The above page is at https://docs.blender.org/manual/en/dev/editors/image/image_settings.html https://docs.blender.org/manual/vi/3.4/editors/3dview/display/overlays.html ( this repeats over many pages - : ../../editors/3dview/display/overlays.rst - : ../../editors/dope_sheet/introduction.rst:75 - : ../../editors/outliner/interface.rst:148 ../../editors/uv/selecting.rst:139 - : ../../files/blend/rename.rst ../../files/import_export/grease_pencil_pdf.rst - : ../../files/import_export/grease_pencil_svg.rst - : ../../grease_pencil/properties/onion_skinning.rst - : ../../modeling/curves/selecting.rst:112 - : ../../modeling/meshes/editing/mesh/sort_elements.rst:32 - : ../../modeling/meshes/selecting/checker_deselect.rst:24 - : ../../modeling/meshes/selecting/linked.rst:75 # : ../../modeling/surfaces/selecting.rst:100 ) https://docs.blender.org/manual/vi/3.4/editors/image/introduction.html (This repeats: - : ../../editors/image/introduction.rst:78 ../../editors/uv/introduction.rst - : ../../editors/video_sequencer/preview/header.rst:69 ) This page really affects the render of the page on desktop browsers, due to the inclusion of images and wraparound texts: https://docs.blender.org/manual/en/dev/editors/graph_editor/fcurves/properties.html This table format, however, appeared OK on mobile devices: https://docs.blender.org/manual/vi/3.4/editors/3dview/modes.html However, this page is also very imbalance on mobile devices, due to the keyboard, don't know how to avoid it: https://docs.blender.org/manual/vi/3.4/editors/3dview/navigate/walk_fly.html I haven't gone right through the whole Blender manual tree, so I cannot locate all instances, but those are problems on mobile device, such as iPhone I'm using. I don't know how the layout (css and javascript) is designed for mobile devices, but I know they are separate from desktop version. So may be the problem is not from the source end, but from the web-page layout ends. I am speculating here of course, so please investigate thoroughly before approach to fix the problem. I took a little digging around and it turned out to be the :param1: ``` text describe param1 ``` render as param1: text describe param1 ``` <wrapped round at the edge of where the 'text' started so leaving the whole section for param1 blank, like a tabular format> ``` I personally think this format is VERY limited, including on the Desktop browsers, and should be avoided as much as possible. I think we could try the table format for those instead : .. _tab-view3d-modes: .. list-table:: Blender's Modes ``` :header-rows: 0 :class: valign :widths: 30 60 ``` Best regards, Hoang Tran

Hoang Duy Tran commented

2022-09-01 00:28:26 +02:00

I felt lazy to open another bug report so I add an extra problem regarding to icons for playing buttons in this page:

https://docs.blender.org/manual/en/dev/editors/timeline.html

Noticed the "Jump to Start" etc.. and lookout for their corresponding icons.

I felt lazy to open another bug report so I add an extra problem regarding to icons for playing buttons in this page: https://docs.blender.org/manual/en/dev/editors/timeline.html ![Screenshot 2022-08-31 at 23.24.09.png](https://archive.blender.org/developer/F13442796/Screenshot_2022-08-31_at_23.24.09.png) Noticed the "Jump to Start" etc.. and lookout for their corresponding icons.

Aaron Carlisle commented

2022-09-01 20:12:56 +02:00

Changed status from 'Needs User Info' to: 'Resolved'

Aaron Carlisle closed this issue

2022-09-01 20:12:56 +02:00

Aaron Carlisle self-assigned this 2022-09-01 20:12:56 +02:00

Aaron Carlisle commented

2022-09-01 20:12:56 +02:00

This is a bug in the theme and will be fixed with https://github.com/readthedocs/sphinx_rtd_theme/pull/1137 and there is no need to adjust the documentation.

I am closing this report as this will be fixed upstream.

There should be a new release of the RTD Theme so this should get fixed soon.

This is a bug in the theme and will be fixed with https://github.com/readthedocs/sphinx_rtd_theme/pull/1137 and there is no need to adjust the documentation. I am closing this report as this will be fixed upstream. There should be a new release of the RTD Theme so this should get fixed soon.

Hoang Duy Tran changed title from ~~Manuel needs to illuminate tables because it affects the displays on mobile devices~~ to Manual needs to illuminate tables because it affects the displays on mobile devices

2022-09-05 01:37:38 +02:00

Hoang Duy Tran changed title from ~~Manual needs to illuminate tables because it affects the displays on mobile devices~~ to Manual needs to correct tables because it affects the displays on mobile devices

2022-09-05 01:38:21 +02:00

Hoang Duy Tran commented

2022-09-09 12:57:12 +02:00

Raised this with RTD team:

https://github.com/readthedocs/sphinx_rtd_theme/issues/1340

Raised this with RTD team: https://github.com/readthedocs/sphinx_rtd_theme/issues/1340

Hoang Duy Tran commented

2023-03-05 08:48:56 +01:00

Just out of interest, this link:

https://sphinx-hoverxref.readthedocs.io/en/latest/usage.html

introduces something like :hoverxref: which is very interesting. I think we should start using it.

Just out of interest, this link: https://sphinx-hoverxref.readthedocs.io/en/latest/usage.html introduces something like **:hoverxref:** which is very interesting. I think we should start using it.

Aaron Carlisle commented

2023-03-05 19:02:41 +01:00

sphinx-hoverxref only works on the readthedocs platform.

I have tested out https://sphinx-tippy.readthedocs.io/en/latest/ which is a similar solution that works on any platform. There were a few issues however it is diffidently something I want to look more into.

`sphinx-hoverxref` only works on the readthedocs platform. I have tested out https://sphinx-tippy.readthedocs.io/en/latest/ which is a similar solution that works on any platform. There were a few issues however it is diffidently something I want to look more into.

Sign in to join this conversation.

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Manual needs to correct tables because it affects the displays on mobile devices #100721

: ../../modeling/surfaces/selecting.rst:100