AcademySoftwareFoundation/openexr

Need better table formatting for website documentation

Open

#1,847 opened on Sep 25, 2024

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C (695 forks)auto 404
help wanted

Repository metrics

Stars
 (1,812 stars)
PR merge metrics
 (PR metrics pending)

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.

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

Research direction
Investigate how to embed raw HTML in the existing documentation build system (likely Sphinx) to improve table formatting for complex content like the tiled image page.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70