Reorganize repo/readthedocs documentation (AcademySoftwareFoundation#293

) * 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 · Feb 27, 2023 · 35ba8ea · 35ba8ea
1 parent e92ca03
commit 35ba8ea
Show file tree

Hide file tree

Showing 32 changed files with 1,570 additions and 606 deletions.
diff --git a/.github/workflows/ci_workflow.yml b/.github/workflows/ci_workflow.yml
@@ -36,6 +36,7 @@ jobs:
        ${{ matrix.python-desc }},
        config=${{ matrix.build-type }}, 
        shared=${{ matrix.build-shared }}, 
+       docs=${{ matrix.build-docs }}, 
        cxx=${{ matrix.cxx-standard }}>'
     # GH-hosted VM. The build runs in CentOS 7 'container' defined below.
     runs-on: ubuntu-latest
@@ -60,6 +61,7 @@ jobs:
             compiler-desc: gcc9.3.1
             python: 'ON'
             python-desc: python3.9.7
+            build-docs: 'ON'
             vfx-cy: 2022
 
           # C++17, Python 3.9.7, Debug
@@ -72,6 +74,7 @@ jobs:
             compiler-desc: gcc9.3.1
             python: 'ON'
             python-desc: python3.9.7
+            build-docs: 'OFF'
             vfx-cy: 2022
 
           # C++17, Python 3.9.7, Static
@@ -84,6 +87,7 @@ jobs:
             compiler-desc: gcc9.3.1
             python: 'ON'
             python-desc: python3.9.7
+            build-docs: 'OFF'
             vfx-cy: 2022
 
           # C++14, Python 3.9.7, Static
@@ -96,6 +100,7 @@ jobs:
             compiler-desc: gcc9.3.1
             python: 'ON'
             python-desc: python3.9.7
+            build-docs: 'OFF'
             vfx-cy: 2022
 
           # C++17, no Python
@@ -123,6 +128,7 @@ jobs:
             compiler-desc: gcc9.3.1
             python: 'ON'
             python-desc: python3.7.9
+            build-docs: 'OFF'
             vfx-cy: 2021
 
           # -------------------------------------------------------------------
@@ -138,6 +144,7 @@ jobs:
             compiler-desc: gcc6.3.1
             python: 'ON'
             python-desc: python3.7.3
+            build-docs: 'OFF'
             vfx-cy: 2020
 
           # -------------------------------------------------------------------
@@ -154,6 +161,7 @@ jobs:
             compiler-desc: gcc6.3.1
             python: 'ON'
             python-desc: python2.7.15
+            build-docs: 'OFF'
             vfx-cy: 2019
 
           # -------------------------------------------------------------------
@@ -169,6 +177,7 @@ jobs:
             compiler-desc: clang10.4
             python: 'ON'
             python-desc: python3.9.7
+            build-docs: 'OFF'
             vfx-cy: 2022
 
           # C++17, Python 3.9.7, Debug
@@ -181,6 +190,7 @@ jobs:
             compiler-desc: clang10.4
             python: 'ON'
             python-desc: python3.9.7
+            build-docs: 'OFF'
             vfx-cy: 2022
 
           # C++17, Python 3.9.7, Static
@@ -193,6 +203,7 @@ jobs:
             compiler-desc: clang10.4
             python: 'ON'
             python-desc: python3.9.7
+            build-docs: 'OFF'
             vfx-cy: 2022
 
           # C++14, Python 3.9.7, Static
@@ -205,6 +216,7 @@ jobs:
             compiler-desc: clang10.4
             python: 'ON'
             python-desc: python3.9.7
+            build-docs: 'OFF'
             vfx-cy: 2022
 
           # -------------------------------------------------------------------
@@ -220,6 +232,7 @@ jobs:
             compiler-desc: clang10.4
             python: 'ON'
             python-desc: python3.7.9
+            build-docs: 'OFF'
             vfx-cy: 2021
 
           # -------------------------------------------------------------------
@@ -235,6 +248,7 @@ jobs:
             compiler-desc: clang7.8
             python: 'ON'
             python-desc: python3.7.3
+            build-docs: 'OFF'
             vfx-cy: 2020
 
           # -------------------------------------------------------------------
@@ -251,6 +265,7 @@ jobs:
             compiler-desc: clang7.8
             python: 'ON'
             python-desc: python2.7.15
+            build-docs: 'OFF'
             vfx-cy: 2019
 
     env:
@@ -264,6 +279,9 @@ jobs:
           mkdir _install
           mkdir _build
           mkdir _examples
+      - name: Install docs env
+        run: share/ci/scripts/linux/yum/install_docs_env.sh
+        if: matrix.build-docs == 'ON'
       - name: Configure
         run: |
           cmake .. \
@@ -274,7 +292,8 @@ jobs:
                 -DCMAKE_VERBOSE_MAKEFILE:BOOL='OFF' \
                 -DBUILD_SHARED_LIBS=${{ matrix.build-shared }} \
                 -DPYTHON=${{ matrix.python }} \
-                -DUSE_PYTHON2=${{ matrix.use-python2 }}
+                -DUSE_PYTHON2=${{ matrix.use-python2 }} \
+                -DBUILD_DOCS=${{ matrix.build-docs }}
         working-directory: _build
       - name: Build
         run: |
@@ -329,7 +348,7 @@ jobs:
        config=${{ matrix.build-type }}, 
        shared=${{ matrix.build-shared }}, 
        cxx=${{ matrix.cxx-standard }}, 
-       docs=${{ matrix.build-docs }}>'
+       docs=OFF>'
     runs-on: macos-10.15
     strategy:
       matrix:
@@ -448,7 +467,7 @@ jobs:
        shared=${{ matrix.build-shared }}, 
        cxx=${{ matrix.cxx-standard }}, 
        python=OFF, 
-       docs=${{ matrix.build-docs }}>'
+       docs=OFF>'
     runs-on: windows-${{ matrix.osver }}
     strategy:
       matrix:
@@ -461,7 +480,6 @@ jobs:
           - build: 1
             build-type: Release
             build-shared: 'ON'
-            build-docs: 'ON'
             compiler-desc: msvc16.11
             cxx-standard: 17
             vfx-cy: 2022
@@ -472,15 +490,13 @@ jobs:
           ## - build: 2
           ##   build-type: Debug
           ##   build-shared: 'ON'
-          ##   build-docs: 'OFF'
           ##   cxx-standard: 17
           ##   exclude-tests:
 
           # C++17, Release Static
           - build: 3
             build-type: Release
             build-shared: 'OFF'
-            build-docs: 'OFF'
             compiler-desc: msvc16.11
             cxx-standard: 17
             vfx-cy: 2022
@@ -494,7 +510,6 @@ jobs:
           - build: 4
             build-type: Release
             build-shared: 'ON'
-            build-docs: 'ON'
             compiler-desc: msvc17.1
             cxx-standard: 17
             vfx-cy: 2022
@@ -505,15 +520,13 @@ jobs:
           ## - build: 5
           ##   build-type: Debug
           ##   build-shared: 'ON'
-          ##   build-docs: 'OFF'
           ##   cxx-standard: 17
           ##   exclude-tests:
 
           # C++17, Release Static
           - build: 6
             build-type: Release
             build-shared: 'OFF'
-            build-docs: 'OFF'
             compiler-desc: msvc17.1
             cxx-standard: 17
             vfx-cy: 2022
@@ -527,7 +540,6 @@ jobs:
           - build: 7
             build-type: Release
             build-shared: 'ON'
-            build-docs: 'OFF'
             compiler-desc: msvc16.11
             cxx-standard: 14
             vfx-cy: 2020
@@ -541,7 +553,6 @@ jobs:
           - build: 8
             build-type: Release
             build-shared: 'ON'
-            build-docs: 'OFF'
             compiler-desc: msvc16.11
             cxx-standard: 11
             exclude-tests:

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -73,8 +73,8 @@ if (PYTHON)
   add_subdirectory(src/python)
 endif()
 
-option(DOCS "Set ON to build html documentation")
-if (DOCS AND NOT IMATH_IS_SUBPROJECT)
+option(BUILD_DOCS "Set ON to build readthedocs documentation")
+if (BUILD_DOCS AND NOT IMATH_IS_SUBPROJECT)
   option(INSTALL_DOCS "Set ON to install html documentation" ON)
   add_subdirectory(docs)
 endif()

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,3 +1,6 @@
+<!-- SPDX-License-Identifier: BSD-3-Clause -->
+<!-- Copyright (c) Contributors to the OpenEXR Project -->
+
 # Contributing to Imath
 
 Thank you for your interest in contributing to Imath. This document
@@ -17,7 +20,7 @@ follows OpenEXR's governance and contribution policies.
 For a description of the roles and responsibilities of the various
 members of the OpenEXR community, see [GOVERNANCE](GOVERNANCE.md), and
 for further details, see the OpenEXR project's [Technical
-Charter](https://github.com/AcademySoftwareFoundation/openexr/blob/main/ASWF/charter/OpenEXR-Technical-Charter.md). Briefly,
+Charter](ASWF/charter/OpenEXR-Technical-Charter.md). Briefly,
 a "contributor" is anyone who submits content to the project, a
 "committer" reviews and approves such submissions, and the "Technical
 Steering Committee" provides general project oversight and governance.

diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -1,4 +1,7 @@
-This is a list of contributors to the OpenEXR project, sorted
+<!-- SPDX-License-Identifier: BSD-3-Clause -->
+<!-- Copyright (c) Contributors to the OpenEXR Project -->
+
+This is a list of contributors to the Imath project, sorted
 alphabetically by first name.
 
 If you know of missing, please email: [email protected].

diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -1,3 +1,6 @@
+<!-- SPDX-License-Identifier: BSD-3-Clause -->
+<!-- Copyright (c) Contributors to the OpenEXR Project -->
+
 # OpenEXR Project Roles and Responsibilities
 
 Imath is a subproject of OpenEXR and follows OpenEXR's governance and
@@ -72,9 +75,9 @@ [email protected].
 ## Technical Steering Committee
 
 The Technical Steering Committee (TSC) oversees the overall technical
-direction of OpenEXR, as defined in the project [Technical
-Charter](https://github.com/AcademySoftwareFoundation/openexr/blob/main/ASWF/charter/OpenEXR-Technical-Charter.md)
-This charter defines the TSC member terms and succession policies.
+direction of OpenEXR, as defined in the project
+[charter](ASWF/charter/OpenEXR-Technical-Charter.md).  This
+charter defines the TSC member terms and succession policies.
 
 The responsibilities of the TSC include: