Skip to content

Commit

Permalink
Updates to API documentation generation
Browse files Browse the repository at this point in the history
- Add CSS settings from Doxygen Awesome.
- Add a scaled MaterialX logo to API documentation.
- Explicitly set the Main Page in the Doxyfile.
  • Loading branch information
jstone-lucasfilm committed Nov 12, 2022
1 parent 76edbeb commit 685a8eb
Show file tree
Hide file tree
Showing 6 changed files with 2,441 additions and 4 deletions.
9 changes: 6 additions & 3 deletions documents/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR})
set(DOXYGEN_HTML_OUTPUT_DIR ${DOXYGEN_OUTPUT_DIR}/MaterialXDocs)
set(DOXYGEN_INPUT_LIST ${CMAKE_SOURCE_DIR}/documents/DeveloperGuide
set(DOXYGEN_HTML_OUTPUT_DIR ${DOXYGEN_OUTPUT_DIR}/html)
set(DOXYGEN_INPUT_LIST ${CMAKE_SOURCE_DIR}/documents/DeveloperGuide/MainPage.md
${CMAKE_SOURCE_DIR}/source/MaterialXCore
${CMAKE_SOURCE_DIR}/source/MaterialXFormat
${CMAKE_SOURCE_DIR}/source/MaterialXGenShader
Expand All @@ -25,7 +25,10 @@ if(DOXYGEN_FOUND)
COMMENT "Generating HTML documentation: ${DOXYGEN_HTML_OUTPUT_DIR}/index.html")
add_custom_command(TARGET MaterialXDocs PRE_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_directory
${CMAKE_SOURCE_DIR}/resources/Images ${CMAKE_CURRENT_BINARY_DIR})
${CMAKE_SOURCE_DIR}/documents/DoxygenAwesome ${CMAKE_CURRENT_BINARY_DIR})
add_custom_command(TARGET MaterialXDocs PRE_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_directory
${CMAKE_SOURCE_DIR}/documents/Images ${CMAKE_CURRENT_BINARY_DIR})
install(DIRECTORY ${DOXYGEN_HTML_OUTPUT_DIR}
DESTINATION "documents" MESSAGE_NEVER)
endif(DOXYGEN_FOUND)
2 changes: 1 addition & 1 deletion documents/DeveloperGuide/MainPage.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# MaterialX Overview {#mainpage}
# MaterialX Overview

MaterialX is an open standard for transfer of rich material and look-development content between applications and renderers. Originated at Lucasfilm in 2012, MaterialX has been used by Industrial Light & Magic (ILM) in feature films such as _Star Wars: The Force Awakens_ and real-time experiences such as _Trials on Tatooine_, and it remains the central material format for new ILM productions.

Expand Down
8 changes: 8 additions & 0 deletions documents/Doxyfile.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
PROJECT_NAME = MaterialX
PROJECT_NUMBER = ${MATERIALX_MAJOR_VERSION}.${MATERIALX_MINOR_VERSION}.${MATERIALX_BUILD_VERSION}
PROJECT_LOGO = MaterialXLogo_200x155.png

USE_MDFILE_AS_MAINPAGE = MainPage.md
HTML_EXTRA_STYLESHEET = doxygen-awesome.css

INPUT = ${DOXYGEN_INPUT_STR}
OUTPUT_DIRECTORY = ${DOXYGEN_OUTPUT_DIR}
Expand All @@ -13,5 +17,9 @@ EXTRACT_LOCAL_CLASSES = NO
GENERATE_TODOLIST = NO
GENERATE_LATEX = NO

GENERATE_TREEVIEW = YES
DISABLE_INDEX = NO
FULL_SIDEBAR = NO

QUIET = YES
WARN_IF_UNDOCUMENTED = NO
21 changes: 21 additions & 0 deletions documents/DoxygenAwesome/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 jothepro

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading

0 comments on commit 685a8eb

Please sign in to comment.