Initial doxygen/sphinx/breathe/readthedocs docs #1077
Merged
Conversation
This file contains 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
I converted TechnicalIntroduction.odt, ReadingAndWritingImageFiles.odt, and OpeNEXRFileLayout.odt to .rst and fixed up the formatting. Still some glitches but a good enough place to start. Also, replace references to "IlmImf" with "OpenEXR". Preview the readthedocs page here: https://cary-ilm-openexr.readthedocs.io/en/latest/index.html Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
meshula
approved these changes
Jul 2, 2021
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.
I converted TechnicalIntroduction.odt, ReadingAndWritingImageFiles.odt, and OpeNEXRFileLayout.odt to .rst and fixed up the formatting. Still some glitches but a good enough place to start. The example source code is now in separate files in docs/src/.
Also, replace references to "IlmImf" with "OpenEXR". Still needs quite a bit of modernization.
Preview the readthedocs page here:
https://cary-ilm-openexr.readthedocs.io/en/latest/index.html
When this is merged, it will appear here:
https://readthedocs.org/projects/openexr/