Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First draft of rst/readthedocs for C API/OpenEXRCore #1088

Merged
merged 4 commits into from
Jul 15, 2021

Conversation

cary-ilm
Copy link
Member

  • Reference section is still a bit unwieldy, could use a better organization
  • Remove the _exr_attribute_t from typedef in openexr_attr.h; it
    confuses sphinx, and it's not necessary (in this case).

Preview the readthedocs here: https://cary-ilm-openexr.readthedocs.io/en/latest/OpenEXRCoreAPI.html

Signed-off-by: Cary Phillips [email protected]

* Reference section is still a bit unwieldy, could use a better organization
* Remove the _exr_attribute_t from typedef in openexr_attr.h; it
  confuses sphinx, and it's not necessary (in this case).

Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
Also, add missing docs/src .cpp files.

Signed-off-by: Cary Phillips <[email protected]>
@cary-ilm
Copy link
Member Author

Can someone give this a thumbs up so I can merge it?

I pushed some extra commits that update README.md and add introductory material to the readthedocs landing page.

Copy link

@kthurston kthurston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did notice a couple of typos (which are probably my typos from the google doc I had started), but was trying to figure out the best way to collaborate to fix those, but if you merge, I can just submit PR on top of that, will be good

@cary-ilm cary-ilm merged commit c1fee45 into AcademySoftwareFoundation:master Jul 15, 2021
@cary-ilm cary-ilm added the v3.1.0 label Sep 2, 2021
@cary-ilm cary-ilm deleted the core-rst branch November 5, 2022 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants