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

Reorganize repo/readthedocs documentation #293

Merged
merged 13 commits into from
Feb 19, 2023

Conversation

cary-ilm
Copy link
Member

Similar to the recently-reorganized openexr:

  • Use the sphinx-press-theme
  • Similar top-level pages: Overview, Concepts, Classes, Functions, Index, Install, License, About, Github
  • Redistribute content between readthedocs/rst and repo/md
  • Rename CMake doc option to BUILD_DOCS instead of DOC
  • Enable building of docs in the CI (for only one build, which is sufficient)

Preview the docs here temporarily: https://cary-ilm-imath.readthedocs.io/en/doc-reorg2

Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
* ci

Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
@cary-ilm cary-ilm merged commit e52b07d into AcademySoftwareFoundation:main Feb 19, 2023
cary-ilm added a commit to cary-ilm/Imath that referenced this pull request Feb 27, 2023
)

* Doc reorg

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

* favicon

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

* * reorg
* ci

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

* README.md

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

* more reorg

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

* jinja < 3.1

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

* pip3

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

* typo

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

* requirements

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

* sphinx 4.4.0

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

* latex

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

* tt

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

* formatting

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

---------

Signed-off-by: Cary Phillips <[email protected]>
cary-ilm added a commit that referenced this pull request Feb 28, 2023
* Doc reorg

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

* favicon

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

* * reorg
* ci

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

* README.md

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

* more reorg

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

* jinja < 3.1

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

* pip3

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

* typo

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

* requirements

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

* sphinx 4.4.0

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

* latex

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

* tt

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

* formatting

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

---------

Signed-off-by: Cary Phillips <[email protected]>
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