AcademySoftwareFoundation/openexr

Convert code-blocks to literalincludes in OpenEXRCoreAPI.rst

Open

#1,548 opened on Sep 11, 2023

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

Repository metrics

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

Description

The example code in website/OpenEXRCoreAPI.rst should be moved to individual files in website/src and included in the documentation files via .. literalinclude::, and also included in website/src/all.cpp so that it get built by CMake for testing and validation. See the other uses of literalinclude as examples.

This task requires some basic familiarity with reStructuredText and sphinx but the concepts are easy to pick up from other examples. See Building the Website for how to test the formatting.

Contributor guide

Research direction
Move the example code blocks from website/OpenEXRCoreAPI.rst to individual files in website/src, add `.. literalinclude::` directives to include them, and add the new source files to website/src/all.cpp for build testing via CMake. Refer to existing uses of literalinclude in the repository as examples.
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.
1-3 hours
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
reStructuredTextsphinxGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80