mirror of
https://github.com/TheLartians/ModernCppStarter.git
synced 2025-09-01 06:30:52 +02:00
Setup config for Pages section
This commit is contained in:
parent
919a07044a
commit
0f6c85d20d
5 changed files with 28 additions and 2 deletions
|
@ -31,10 +31,15 @@ configure_file(
|
||||||
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
||||||
)
|
)
|
||||||
|
|
||||||
|
configure_file(
|
||||||
|
${CMAKE_CURRENT_LIST_DIR}/conf.py
|
||||||
|
${CMAKE_CURRENT_BINARY_DIR}/conf.py
|
||||||
|
)
|
||||||
|
|
||||||
add_custom_target(
|
add_custom_target(
|
||||||
GenerateDocs
|
GenerateDocs
|
||||||
${CMAKE_COMMAND} -E make_directory "${DOXYGEN_OUTPUT_DIRECTORY}"
|
${CMAKE_COMMAND} -E make_directory "${DOXYGEN_OUTPUT_DIRECTORY}"
|
||||||
COMMAND "${MCSS_SOURCE_DIR}/documentation/doxygen.py" "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile"
|
COMMAND "${MCSS_SOURCE_DIR}/documentation/doxygen.py" "${CMAKE_CURRENT_BINARY_DIR}/conf.py"
|
||||||
COMMAND echo "Docs written to: ${DOXYGEN_OUTPUT_DIRECTORY}"
|
COMMAND echo "Docs written to: ${DOXYGEN_OUTPUT_DIRECTORY}"
|
||||||
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
|
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
|
||||||
)
|
)
|
||||||
|
|
|
@ -7,7 +7,7 @@ PROJECT_NAME = @DOXYGEN_PROJECT_NAME@
|
||||||
PROJECT_NUMBER = @DOXYGEN_PROJECT_VERSION@
|
PROJECT_NUMBER = @DOXYGEN_PROJECT_VERSION@
|
||||||
|
|
||||||
# Add sources
|
# Add sources
|
||||||
INPUT = @DOXYGEN_PROJECT_ROOT@/README.md @DOXYGEN_PROJECT_ROOT@/include @DOXYGEN_PROJECT_ROOT@/source
|
INPUT = @DOXYGEN_PROJECT_ROOT@/README.md @DOXYGEN_PROJECT_ROOT@/include @DOXYGEN_PROJECT_ROOT@/source @DOXYGEN_PROJECT_ROOT@/documentation
|
||||||
EXTRACT_ALL = YES
|
EXTRACT_ALL = YES
|
||||||
RECURSIVE = YES
|
RECURSIVE = YES
|
||||||
|
|
||||||
|
|
11
documentation/about.dox
Normal file
11
documentation/about.dox
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
/** @page about About Greeter
|
||||||
|
@tableofcontents
|
||||||
|
Everyone likes a good, personalized greeting.
|
||||||
|
@section sec An example section
|
||||||
|
This page contains the subsections @ref subsection1 and @ref subsection2.
|
||||||
|
For more info, see page @ref page2.
|
||||||
|
@subsection subsection1 The first subsection
|
||||||
|
Text.
|
||||||
|
@subsection subsection2 The second subsection
|
||||||
|
More text.
|
||||||
|
*/
|
6
documentation/conf.py
Normal file
6
documentation/conf.py
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
DOXYFILE = 'Doxyfile'
|
||||||
|
|
||||||
|
LINKS_NAVBAR1 = [
|
||||||
|
(None, 'pages', [(None, 'about')]),
|
||||||
|
(None, 'namespaces', []),
|
||||||
|
]
|
|
@ -1,5 +1,9 @@
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
|
/** @file
|
||||||
|
* @brief Class @ref greeter::Greeter
|
||||||
|
*/
|
||||||
|
|
||||||
#include <string>
|
#include <string>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue