Skip to content

Commit a529b87

Browse files
committed
Fix Doxygen documentation
1 parent 6e0d236 commit a529b87

File tree

4 files changed

+38
-58
lines changed

4 files changed

+38
-58
lines changed

.readthedocs.yaml

Lines changed: 0 additions & 37 deletions
This file was deleted.

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ ENDIF(COMMAND cmake_policy)
2828

2929
OPTION(ENABLE_TESTS OFF)
3030
#OPTION(ENABLE_EXAMPLES OFF)
31-
OPTION(ENABLE_DOCS OFF)
3231
OPTION(ENABLE_WEBOTS OFF)
3332
#OPTION(ENABLE_CHRONO OFF)
3433

3534
SET(ENABLE_EXAMPLES ON)
3635
SET(ENABLE_CHRONO ON)
3736
SET(ENABLE_OPENCV ON)
3837
SET(ENABLE_MQTT ON)
38+
SET(ENABLE_DOCS ON)
3939
SET(CMAKE_BUILD_TYPE "Release")
4040
SET(CMAKE_CXX_STANDARD 20)
4141
SET(CMAKE_CXX_STANDARD_REQUIRED True)

doc/CMakeLists.txt

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,48 @@ IF (NOT DOXYGEN_FOUND)
44
return()
55
ENDIF()
66

7+
8+
SET(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_SOURCE_DIR}/docs)
9+
10+
# Configure Doxyfile
11+
SET(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
12+
SET(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
13+
714
# just output XML since this is what Breathe consumes
8-
SET(DOXYGEN_GENERATE_HTML NO)
9-
SET(DOXYGEN_GENERATE_XML YES)
15+
SET(DOXYGEN_GENERATE_HTML YES)
16+
SET(DOXYGEN_GENERATE_XML NO)
1017

1118
# don't generate documentation from implementation details
12-
set(DOXYGEN_EXCLUDE_PATTERNS "*/extern/*")
19+
#SET(DOXYGEN_EXCLUDE_PATTERNS "*/extern/*")
1320

1421
# print paths relative to include directory
15-
SET(DOXYGEN_STRIP_FROM_PATH "${PROJECT_SOURCE_DIR}/src/gymfcpp")
22+
#SET(DOXYGEN_STRIP_FROM_PATH "${PROJECT_SOURCE_DIR}/src/bitrl")
23+
24+
configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
25+
26+
27+
add_custom_target(doc
28+
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_OUT}
29+
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
30+
COMMENT "Generating API documentation with Doxygen..."
31+
VERBATIM
32+
)
1633

1734
# Note: use doxygen_add_docs(doxygen-doc ALL ...) if you want your documentation
1835
# to be created by default each time you build. Without the keyword you need to
1936
# explicitly invoke building of the 'doc' target.
20-
doxygen_add_docs(doxygen-doc ${PROJECT_SOURCE_DIR}/src/bitrl COMMENT "Generating API documentation with Doxygen")
21-
22-
find_package(Sphinx REQUIRED)
23-
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in
24-
${CMAKE_CURRENT_BINARY_DIR}/conf.py @ONLY)
25-
26-
add_custom_target(
27-
sphinx-doc ALL
28-
COMMAND ${SPHINX_EXECUTABLE} -b html -c ${CMAKE_CURRENT_BINARY_DIR}
29-
${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}
30-
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
31-
COMMENT "Generating API documentation with Sphinx"
32-
VERBATIM)
33-
34-
add_dependencies(sphinx-doc doxygen-doc)
37+
#doxygen_add_docs(doxygen-doc ${PROJECT_SOURCE_DIR}/src/bitrl COMMENT "Generating API documentation with Doxygen")
38+
#
39+
#
40+
#configure_file(${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in
41+
# ${CMAKE_CURRENT_BINARY_DIR}/conf.py @ONLY)
42+
#
43+
#add_custom_target(
44+
# sphinx-doc ALL
45+
# COMMAND ${SPHINX_EXECUTABLE} -b html -c ${CMAKE_CURRENT_BINARY_DIR}
46+
# ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}
47+
# WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
48+
# COMMENT "Generating API documentation with Sphinx"
49+
# VERBATIM)
50+
#
51+
#add_dependencies(sphinx-doc doxygen-doc)

doc/Doxyfile.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@ GENERATE_HTML = YES
1414
HTML_OUTPUT = .
1515

1616
EXTRACT_ALL = YES
17-
17+
EXCLUDE = @PROJECT_SOURCE_DIR@/src/bitrl/extern
1818
#---------------------------------------------------------------------------
1919

0 commit comments

Comments
 (0)