AcademySoftwareFoundation / AcademySoftwareFoundation/openexr

Convert code-blocks to literalincludes in OpenEXRCoreAPI.rst

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

Description

The example code in [website/OpenEXRCoreAPI.rst](https://github.com/AcademySoftwareFoundation/openexr/blob/main/website/ReadingAndWritingImageFiles.rst) should be moved to individual files in [website/src](https://github.com/AcademySoftwareFoundation/openexr/tree/main/website/src) and included in the documentation files via `.. literalinclude::`, and also included in [website/src/all.cpp](https://github.com/AcademySoftwareFoundation/openexr/blob/main/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](https://docutils.sourceforge.io/rst.html) and [sphinx](https://www.sphinx-doc.org/en/master) but the concepts are easy to pick up from other examples. See [Building the Website](https://openexr.com/en/latest/install.html#building-the-website) for how to test the formatting.

Contributor guide

Open the contributing guide

Research direction

Compare other literalinclude uses in the documentation, then inspect website/OpenEXRCoreAPI.rst, the individual files under website/src, and website/src/all.cpp. Move the example code into separate source files, reference them with literalinclude, and add them to all.cpp so CMake builds them. Follow Building the Website to verify formatting and validation.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, cpp
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.