Include pyktx reference in Doxygen website

KhronosGroup · Sep 4, 2023 · 7dfc21e · 7dfc21e
1 parent 68e263d
commit 7dfc21e
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 26 deletions.
diff --git a/cmake/docs.cmake b/cmake/docs.cmake
@@ -186,6 +186,17 @@ function( CreateDocJSWrappers )
     add_docs_cmake_plus( jswrappers.doc pkgdoc/jswrappersDoxyLayout.xml )
 endfunction()
 
+# pyktxwrappers.doc
+function( CreateDocPyktxWrappers )
+    add_custom_command(
+        TARGET libktx.doc
+        POST_BUILD
+        COMMAND
+            ${CMAKE_COMMAND} -E copy_directory ${KTX_BUILD_DIR}/interface/python_binding/docs/html/pyktx/html ${KTX_BUILD_DIR}/docs/html/pyktx
+    )
+    add_dependencies( libktx.doc pyktx )
+endfunction()
+
 # ktxpkg.doc
 function( CreateDocKTX )
     set( DOXYGEN_PROJECT_NAME "Khronos Texture Software" )
@@ -212,6 +223,9 @@ endfunction()
 CreateDocLibKTX()
 CreateDocTools()
 CreateDocJSWrappers()
+if (KTX_FEATURE_PY)
+    CreateDocPyktxWrappers()
+endif()
 CreateDocKTX()
 
 add_dependencies( libktx.doc ktxpkg.doc ktx_version )

diff --git a/interface/python_binding/CMakeLists.txt b/interface/python_binding/CMakeLists.txt
@@ -103,27 +103,29 @@ add_test(NAME pyktx
         ${CMAKE_SOURCE_DIR}/interface/python_binding
 )
 
-add_custom_command(
-    TARGET pyktx
-    POST_BUILD
-    COMMAND
-        ${CMAKE_COMMAND} -E env
-            LIBKTX_INCLUDE_DIR=${CMAKE_SOURCE_DIR}/include
-            LIBKTX_LIB_DIR=${LIBKTX_LIB_DIR}
-            DYLD_LIBRARY_PATH=${LIBKTX_LIB_DIR}:$ENV{DYLD_LIBRARY_PATH}
-            LD_LIBRARY_PATH=${LIBKTX_LIB_DIR}:$ENV{LD_LIBRARY_PATH}
-        ${PYTHON_EXECUTABLE} build.py
-    COMMAND
-        ${CMAKE_COMMAND} -E env
-            LIBKTX_INCLUDE_DIR=${CMAKE_SOURCE_DIR}/include
-            LIBKTX_LIB_DIR=${LIBKTX_LIB_DIR}
-        ${PYTHON_EXECUTABLE} -m sphinx.ext.apidoc -o docs ./pyktx --separate
-    COMMAND
-        ${CMAKE_COMMAND} -E env
-            LIBKTX_INCLUDE_DIR=${CMAKE_SOURCE_DIR}/include
-            LIBKTX_LIB_DIR=${LIBKTX_LIB_DIR}
-            SPHINXBUILD=$<IF:$<PLATFORM_ID:Windows>,"${PYTHON_PATH} -m sphinx","">
-        make html
-    WORKING_DIRECTORY
-        ${CMAKE_SOURCE_DIR}/interface/python_binding
-)
+if(KTX_FEATURE_DOC)
+    add_custom_command(
+        TARGET pyktx
+        POST_BUILD
+        COMMAND
+            ${CMAKE_COMMAND} -E env
+                LIBKTX_INCLUDE_DIR=${CMAKE_SOURCE_DIR}/include
+                LIBKTX_LIB_DIR=${LIBKTX_LIB_DIR}
+                DYLD_LIBRARY_PATH=${LIBKTX_LIB_DIR}:$ENV{DYLD_LIBRARY_PATH}
+                LD_LIBRARY_PATH=${LIBKTX_LIB_DIR}:$ENV{LD_LIBRARY_PATH}
+            ${PYTHON_EXECUTABLE} build.py
+        COMMAND
+            ${CMAKE_COMMAND} -E env
+                LIBKTX_INCLUDE_DIR=${CMAKE_SOURCE_DIR}/include
+                LIBKTX_LIB_DIR=${LIBKTX_LIB_DIR}
+            ${PYTHON_EXECUTABLE} -m sphinx.ext.apidoc -o docs ./pyktx --separate
+        COMMAND
+            ${CMAKE_COMMAND} -E env
+                LIBKTX_INCLUDE_DIR=${CMAKE_SOURCE_DIR}/include
+                LIBKTX_LIB_DIR=${LIBKTX_LIB_DIR}
+                SPHINXBUILD=$<IF:$<PLATFORM_ID:Windows>,"${PYTHON_PATH} -m sphinx","sphinx-build">
+            make BUILDDIR="${CMAKE_CURRENT_BINARY_DIR}/docs/html/pyktx" html
+        WORKING_DIRECTORY
+            ${CMAKE_SOURCE_DIR}/interface/python_binding
+    )
+endif()
diff --git a/pkgdoc/packageDoxyLayout.xml b/pkgdoc/packageDoxyLayout.xml
@@ -8,22 +8,23 @@
     <tab type="user"  url="libktx/index.html" title="libktx Reference"/>
     <tab type="user"  url="ktxjswrappers/index.html"
          title="KTX Javascript Wrappers Reference"/>
+    <tab type="user"  url="pyktx/index.html" title="pyktx Reference"/>
     <tab type="user"  url="@ref license" title=""/>
     <tab type="namespaces" visible="no" title="">
       <tab type="namespacelist" visible="no" title="" intro=""/>
       <tab type="namespacemembers" visible="no" title="" intro=""/>
     </tab>
     <tab type="classes" visible="no" title="">
       <tab type="classlist" visible="no" title="" intro=""/>
-      <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 
+      <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
       <tab type="hierarchy" visible="no" title="" intro=""/>
       <tab type="classmembers" visible="no" title="" intro=""/>
     </tab>
     <tab type="files" visible="no" title="">
       <tab type="filelist" visible="no" title="" intro=""/>
       <tab type="globals" visible="no" title="" intro=""/>
     </tab>
-    <tab type="examples" visible="no" title="" intro=""/>  
+    <tab type="examples" visible="no" title="" intro=""/>
   </navindex>
 
   <!-- Layout definition for a class page -->