Update doc

untwine · Sep 29, 2024 · b9e1294 · b9e1294
1 parent a414cc8
commit b9e1294
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 8 deletions.
diff --git a/.github/workflows/docs-deploy.yml b/.github/workflows/docs-deploy.yml
@@ -15,7 +15,7 @@ concurrency:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: macos-latest
 
     steps:
       - uses: actions/checkout@v4
@@ -24,21 +24,24 @@ jobs:
           python-version: "3.x"
 
       - name: Create Build Environment
+        working-directory: ${{runner.temp}}
         run: |
-          sudo apt update
-          sudo apt install -y doxygen
+          brew install doxygen
           python -m pip install --upgrade pip
           python -m pip install -r ${{github.workspace}}/doc/requirements.txt
+          npm install https://github.com/jothepro/doxygen-awesome-css#v2.3.3
           cmake -E make_directory ${{github.workspace}}/build
 
       - name: Build documentation
         working-directory: ${{github.workspace}}/build
         run: |
-          cmake -D "BUILD_TESTS=OFF" ..
+          cmake \
+            -D "BUILD_TESTS=OFF" \
+            -D "DOXYGEN_HTML_EXTRA_STYLESHEET=${{runner.temp}}/node_modules/@jothepro/doxygen-awesome-css/doxygen-awesome.css" ..
           cmake --build . --target documentation
 
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-artifact@v4
         with:
           path: ${{github.workspace}}/build/doc/doc/pxr/arch
 
@@ -47,11 +50,10 @@ jobs:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
 
-    runs-on: ubuntu-latest
+    runs-on: macos-latest
     needs: build
 
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
-
+        uses: actions/deploy-pages@v4
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
@@ -1,6 +1,7 @@
 file(MAKE_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/doc/pxr/arch")
 
 set(DOXYGEN_PROJECT_NAME "Pixar Arch")
+set(DOXYGEN_PROJECT_ICON "${PROJECT_SOURCE_DIR}/doc/sphinx/favicon.ico")
 set(DOXYGEN_HTML_OUTPUT "doc/pxr/arch/doxygen")
 set(DOXYGEN_EXTENSION_MAPPING "h=C++")
 set(DOXYGEN_GENERATE_HTML YES)
@@ -18,6 +19,7 @@ set(DOXYGEN_PREDEFINED doxygen)
 set(DOXYGEN_QUIET YES)
 set(DOXYGEN_EXTRACT_ALL YES)
 set(DOXYGEN_WARN_IF_DOC_ERROR NO)
+set(DOXYGEN_HTML_COLORSTYLE LIGHT)
 set(DOXYGEN_EXCLUDE
     "${PROJECT_SOURCE_DIR}/src/pxr/arch/api.h"
     "${PROJECT_SOURCE_DIR}/src/pxr/arch/pch.h"

diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst
@@ -20,4 +20,5 @@ Abstract architecture-dependent logic.
     diagnostics
     symbol_visibility
     api_reference/index
+    Source Code @ GitHub <https://github.com/untwine/pxr-arch>
     glossary