AcademySoftwareFoundation / AcademySoftwareFoundation/openexr

Need better table formatting for website documentation

Open
#1,847 0 comments 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
C
Stars
1.8k
Forks
700
Avg merge
3d 12h
Merged PRs (30d)
29

Description

RestructuredText grid tables don't do proper text justification, so the formatting is a mess when the content is at all complex, as with tables within cells. See the [tiled image](https://openexr.com/en/latest/TechnicalIntroduction.html#tiled-image).

List-tables work better but don't allow complex embedded text.

What's the best solution for formatting such content?

One option would be raw html formatting.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the website documentation page for the tiled image and comparing its current reStructuredText grid-table and list-table formatting. Investigate how complex content, including tables within cells, is rendered, then determine and document a maintainable formatting approach; completion means the affected page displays correctly without the current justification problems.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.