Reorganize repo/readthedocs documentation #1332
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
* Move content from README.md/repo-top-level to docs/readthedocs * Move technical documentation/src/images to "technical" subdir * CONTRIBUTING, GOVERNANCE, INSTALL, ASWF now on readthedocs 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>
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>
|
Preview the layout here: https://cary-ilm-openexr.readthedocs.io/en/doc-reorg/index.html |
|
Everything looks good to me. I did notice an issue, which is not a documentation issue. #1334 |
meshula
approved these changes
Feb 15, 2023
cary-ilm
added a commit
to cary-ilm/openexr
that referenced
this pull request
Mar 3, 2023
…1332) * Reorganize documentation, move content to readthedocs site * Move content from README.md/repo-top-level to docs/readthedocs * Move technical documentation/src/images to "technical" subdir * CONTRIBUTING, GOVERNANCE, INSTALL, ASWF now on readthedocs Signed-off-by: Cary Phillips <cary@ilm.com> * Remove GOVERNANCE.md, CONTRIBUTING.md, INSTALL.md Signed-off-by: Cary Phillips <cary@ilm.com> * Typos in README.md Signed-off-by: Cary Phillips <cary@ilm.com> * Doc re-org, pass 2 Signed-off-by: Cary Phillips <cary@ilm.com> * Use sphinx-press-theme, toc_redirect.rst Signed-off-by: Cary Phillips <cary@ilm.com> * windowExample1.small.png Signed-off-by: Cary Phillips <cary@ilm.com> * reader/writer Signed-off-by: Cary Phillips <cary@ilm.com> * copyright Signed-off-by: Cary Phillips <cary@ilm.com> * copyright, take 2 Signed-off-by: Cary Phillips <cary@ilm.com> * Copyright notice in *.md Signed-off-by: Cary Phillips <cary@ilm.com> * fix links; use $ instead of % Signed-off-by: Cary Phillips <cary@ilm.com> --------- Signed-off-by: Cary Phillips <cary@ilm.com>
cary-ilm
added a commit
that referenced
this pull request
Mar 5, 2023
* Reorganize documentation, move content to readthedocs site * Move content from README.md/repo-top-level to docs/readthedocs * Move technical documentation/src/images to "technical" subdir * CONTRIBUTING, GOVERNANCE, INSTALL, ASWF now on readthedocs Signed-off-by: Cary Phillips <cary@ilm.com> * Remove GOVERNANCE.md, CONTRIBUTING.md, INSTALL.md Signed-off-by: Cary Phillips <cary@ilm.com> * Typos in README.md Signed-off-by: Cary Phillips <cary@ilm.com> * Doc re-org, pass 2 Signed-off-by: Cary Phillips <cary@ilm.com> * Use sphinx-press-theme, toc_redirect.rst Signed-off-by: Cary Phillips <cary@ilm.com> * windowExample1.small.png Signed-off-by: Cary Phillips <cary@ilm.com> * reader/writer Signed-off-by: Cary Phillips <cary@ilm.com> * copyright Signed-off-by: Cary Phillips <cary@ilm.com> * copyright, take 2 Signed-off-by: Cary Phillips <cary@ilm.com> * Copyright notice in *.md Signed-off-by: Cary Phillips <cary@ilm.com> * fix links; use $ instead of % Signed-off-by: Cary Phillips <cary@ilm.com> --------- Signed-off-by: Cary Phillips <cary@ilm.com>
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.
This PR redistributes content between the github repo and the readthedocs site:
The readthedocs site has information about the OpenEXR library: background, technical concepts, the API, and installing/building. The verbiage here assumes the audience just wants to use the library. A new "Hello, World" program illustrates the most basic use of the library.
The repo has information about the OpenEXR project: mission statement, contribution guidelines, governance, ASWF, etc. The verbiage here assumes the audience maybe be a contributor.
Some information is duplicated so that each landing page has the essentials.
The soon-to-be updated openexr.com will link into each of these as appropriate.
This reorg uses the sphinx_press_theme, similar to OpenColorIO, which imposes a particular structure and some extra dependencies.