Repository navigation
[docs] Add a shared API overview - #364
Merged
antond-weta merged 3 commits intoOct 20, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #364 +/- ##
=======================================
Coverage 92.04% 92.04%
=======================================
Files 17 17
Lines 3959 3959
Branches 591 591
=======================================
Hits 3644 3644
Misses 315 315 Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
soswow
marked this pull request as ready for review
October 19, 2026 05:05
soswow
commented
Oct 19, 2026
Contributor
Author
There was a problem hiding this comment.
fixes problem with tables
before:
after:
soswow
commented
Oct 19, 2026
Contributor
Author
There was a problem hiding this comment.
This has a potential of being a bit sloppy and over-verbose ... =\
Give readers one page that chooses file conversion, the OpenImageIO buffer pipeline, or a metadata or spectral solve. Always describe the buffer API, with a notice that Python requires OpenImageIO 3.2, and keep the documentation build independent of OpenImageIO and the unit tests. Assisted-by: Cursor / Grok 4.7 Signed-off-by: Aleksandr Motsjonov <soswow@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Clarify that the buffer methods are part of the documented API, emphasizing that calling them from Python requires an extension built against OpenImageIO 3.2 or later. Remove redundant explanations and ensure consistency across documentation files regarding the OpenImageIO dependency. Signed-off-by: Aleksandr Motsjonov <soswow@gmail.com>
sphinx_rtd_theme keeps every table cell on one line, so a long cell forces the page to scroll sideways. Wrap prose between words and keep each inline literal intact. Assisted-by: Cursor / Grok 4.7 Signed-off-by: Aleksandr Motsjonov <soswow@gmail.com> Co-authored-by: Cursor <cursoragent@cursor.com>
antond-weta
force-pushed
the
docs/api-overview
branch
from
October 20, 2026 19:11
ec2a68d to
b04bcaa
Compare
antond-weta
approved these changes
Oct 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
src/docs/api/overview.rstas the programming entry point. It distinguishes file conversion, an OpenImageIO buffer pipeline, and metadata or spectral solving, and points to the existing examples and references.src/docsrather than the unit tests.Test plan
python build_scripts/build_docs.py --repo-root . --output-dir site-previewcompletes with no Doxygen or Sphinx warnings.Assisted-by: Cursor / Grok 4.7
The overview was drafted from the public headers, bindings, and existing guides, then checked with a strict local documentation build.
Made with Cursor