Task #9554 (closed)
Opened 7 years ago
Closed 7 years ago
Sizing of included images in sphinx documentation
| Reported by: | rleigh | Owned by: | bpindelski |
|---|---|---|---|
| Priority: | blocker | Milestone: | OMERO-4.4.4 |
| Component: | Documentation | Version: | n.a. |
| Keywords: | sphinx | Cc: | rleigh, bpindelski |
| Resources: | n.a. | Referenced By: | n.a. |
| References: | n.a. | Remaining Time: | n.a. |
| Sprint: | 2012-09-25 (5) |
Description
Images may be sized with
:width: and :height: properties in both image and figure.
Currently, many small dialogues are sized far to big, and could be reduced to 60% of the page list or less. For full-screen application screenshots, they can be kept to the page width to keep them legible.
Change History (6)
comment:1 Changed 7 years ago by rleigh
comment:2 Changed 7 years ago by rleigh
Note that this is only the start, and will need following up with a few more chunks of changes.
comment:3 Changed 7 years ago by jmoore
- Cc rleigh bpindelski added
Blazej, you mentioned doing this. Ok to pass this ticket to you?
comment:4 Changed 7 years ago by bpindelski
- Owner set to bpindelski
comment:5 Changed 7 years ago by jmoore
- Priority changed from minor to blocker
- Sprint set to 2012-09-25 (5)
Marking as blocker since the docs can't go out without this change
comment:6 Changed 7 years ago by bpindelski
- Resolution set to fixed
- Status changed from new to closed
Note: See
TracTickets for help on using
tickets.
You may also have a look at Agilo extensions to the ticket.
https://github.com/openmicroscopy/ome-documentation/pull/25
This PR fixes the figure sizing for some tables, and also makes table formatting more consistent. It uses :figwidth: and :width: for figures, and :width: alone for images. Where it makes the documentation look nicer, it uses figures in place of images to keep things consistent.
Figures can't be placed side-by-side like for images, but they do have captions, which is something I think are generally useful, and add some context to what an image is for. In general, there are far too many images, particularly for the windows install and virtualbox sections, and I think we can reduce the number without losing much, if any, of the clarity or information content.