Documentation: add logo to Doxygen pages
This adds a small KiCad logo in the top left of the Doxygen pages. 54px used as 55px is maximum recommended height for Doxygen logos. For the main docs and the dev docs, this is easily done in the Doxyfile, for the Python docs, as that is run from the binary dir, the source dir is passed as an Environment variable.
This commit is contained in:
parent
ef38a198d1
commit
930f3dd74f
|
@ -46,7 +46,7 @@ PROJECT_BRIEF =
|
|||
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
|
||||
# Doxygen will copy the logo to the output directory.
|
||||
|
||||
PROJECT_LOGO =
|
||||
PROJECT_LOGO = ../kicad_doxygen_logo.png
|
||||
|
||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
||||
# base path where the generated documentation will be put.
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 8.7 KiB |
2
Doxyfile
2
Doxyfile
|
@ -45,7 +45,7 @@ PROJECT_BRIEF =
|
|||
# exceed 55 pixels and the maximum width should not exceed 200 pixels.
|
||||
# Doxygen will copy the logo to the output directory.
|
||||
|
||||
PROJECT_LOGO =
|
||||
PROJECT_LOGO = Documentation/kicad_doxygen_logo.png
|
||||
|
||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
|
||||
# base path where the generated documentation will be put.
|
||||
|
|
|
@ -533,7 +533,10 @@ if( DOXYGEN_FOUND )
|
|||
# Create doxygen-python html
|
||||
add_custom_target( doxygen-python
|
||||
${CMAKE_COMMAND} -E remove_directory doxygen-python
|
||||
COMMAND ${CMAKE_COMMAND} -E env PYTHON_SOURCES_TO_DOC=${DOXYGEN_PYTHON_SOURCES_STR} ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile_python
|
||||
COMMAND ${CMAKE_COMMAND} -E env
|
||||
PYTHON_SOURCES_TO_DOC=${DOXYGEN_PYTHON_SOURCES_STR}
|
||||
CMAKE_SOURCE_DIR=${CMAKE_SOURCE_DIR}
|
||||
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile_python
|
||||
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
|
||||
DEPENDS Doxyfile_python
|
||||
DEPENDS xml-to-docstrings
|
||||
|
|
|
@ -51,7 +51,7 @@ PROJECT_BRIEF =
|
|||
# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo
|
||||
# to the output directory.
|
||||
|
||||
PROJECT_LOGO =
|
||||
PROJECT_LOGO = $(CMAKE_SOURCE_DIR)/Documentation/kicad_doxygen_logo.png
|
||||
|
||||
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
|
||||
# into which the generated documentation will be written. If a relative path is
|
||||
|
|
Loading…
Reference in New Issue