@@ -57,23 +57,22 @@ function(_setup_doxygen)
57
57
endfunction ()
58
58
59
59
function (_setup_doxyrest )
60
- set (DOXYREST_OUTPUT_DIR_NAME docfiles/ libsyclinterface )
60
+ set (DOXYREST_OUTPUT_RELATIVE_DIR_NAME doc_sources/reference_guides/ libsyclinterface/generated )
61
61
# Set the DOXYREST_OUTPUT_DIR variable in both current and parent scope.
62
62
# The variable is used by _setup_sphinx when generating the conf.py file.
63
63
set (DOXYREST_OUTPUT_DIR
64
- ${CMAKE_CURRENT_SOURCE_DIR} /${DOXYREST_OUTPUT_DIR_NAME }
64
+ ${CMAKE_CURRENT_SOURCE_DIR} /${DOXYREST_OUTPUT_RELATIVE_DIR_NAME }
65
65
PARENT_SCOPE
66
66
)
67
67
set (DOXYREST_OUTPUT_DIR
68
- ${CMAKE_CURRENT_SOURCE_DIR} /${DOXYREST_OUTPUT_DIR_NAME }
68
+ ${CMAKE_CURRENT_SOURCE_DIR} /${DOXYREST_OUTPUT_RELATIVE_DIR_NAME }
69
69
)
70
70
set (DOXYREST_CONFIG_IN ${CMAKE_CURRENT_SOURCE_DIR} /doxyrest-config.lua.in )
71
71
set (DOXYREST_CONFIG_OUT ${CMAKE_CURRENT_SOURCE_DIR} /doxyrest-config.lua )
72
72
set (DOXYREST_OUTPUT ${DOXYREST_OUTPUT_DIR} /index.rst )
73
73
set (DOXYGEN_OUTPUT_DIR ${DOC_OUTPUT_DIR} /doxygen )
74
74
75
75
configure_file (${DOXYREST_CONFIG_IN} ${DOXYREST_CONFIG_OUT} @ONLY )
76
- configure_file (${INDEX_DOXYREST_IN} ${INDEX_OUT} @ONLY )
77
76
78
77
add_custom_command (
79
78
OUTPUT ${DOXYREST_OUTPUT}
@@ -83,7 +82,6 @@ function(_setup_doxyrest)
83
82
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
84
83
DEPENDS
85
84
# Other docs files that can be edited manually
86
- ${INDEX_OUT}
87
85
${DOXYGEN_INDEX_FILE}
88
86
MAIN_DEPENDENCY ${DOXYREST_CONFIG_OUT} ${DOXYREST_CONFIG_IN}
89
87
COMMENT "Generating Doxyrest documentation"
@@ -96,46 +94,21 @@ function(_setup_doxyrest)
96
94
endfunction ()
97
95
98
96
function (_setup_sphinx )
99
- set (GENERATE_RST_OUTPUT_DIR
100
- ${CMAKE_CURRENT_SOURCE_DIR} /docfiles/dpctl
101
- )
102
- set (SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR} )
97
+ set (SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR} /doc_sources )
103
98
set (SPHINX_OUTPUT_DIR ${DOC_OUTPUT_DIR} /docs )
104
99
set (SPHINX_INDEX_FILE ${SPHINX_OUTPUT_DIR} /index.html )
105
- set (SPHINX_CONF_IN ${SPHINX_SOURCE} /conf.in )
106
- set (SPHINX_CONF_OUT ${SPHINX_SOURCE} /conf.py )
107
- set (DPCTL_PYAPI_RST_FILE ${GENERATE_RST_OUTPUT_DIR} /dpctl_pyapi.rst )
108
100
109
101
if (DPCTL_ENABLE_DOXYREST )
110
102
set (DEPEND_ON_DOXYREST "Doxyrest" )
111
- else ()
112
- configure_file (${INDEX_NO_DOXYREST_IN} ${INDEX_OUT} @ONLY )
113
103
endif ()
114
104
115
- configure_file (
116
- "${CMAKE_CURRENT_SOURCE_DIR} /generate_rst.py"
117
- ${CMAKE_CURRENT_BINARY_DIR}
118
- )
119
- # A custom command to generate the Python API rst files
120
- add_custom_command (
121
- OUTPUT ${DPCTL_PYAPI_RST_FILE}
122
- COMMAND ${CMAKE_COMMAND} -E make_directory ${GENERATE_RST_OUTPUT_DIR}
123
- COMMAND
124
- "${Python_EXECUTABLE} "
125
- "${CMAKE_CURRENT_BINARY_DIR} /generate_rst.py"
126
- --dir "${GENERATE_RST_OUTPUT_DIR} "
127
- --module "dpctl"
128
- COMMENT "Generating RST files for Python API of dpctl"
129
- )
130
105
add_custom_command (
131
106
OUTPUT ${SPHINX_INDEX_FILE}
132
107
COMMAND
133
108
${SPHINX_EXECUTABLE} -b html
134
109
${SPHINX_SOURCE}
135
110
${SPHINX_OUTPUT_DIR}
136
111
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
137
- DEPENDS ${CMAKE_CURRENT_SOURCE_DIR} /index.rst
138
- MAIN_DEPENDENCY ${SPHINX_CONF_OUT} ${SPHINX_CONF_IN}
139
112
COMMENT "Generating Sphinx documentation"
140
113
)
141
114
# Target to generate Sphinx. Note that the order of the dependencies is
@@ -144,11 +117,10 @@ function(_setup_sphinx)
144
117
Sphinx
145
118
DEPENDS
146
119
${DEPEND_ON_DOXYREST}
147
- ${DPCTL_PYAPI_RST_FILE}
148
120
${SPHINX_INDEX_FILE}
149
121
)
150
122
# Create a conf.py by replacing variables inside @@ with the current values
151
- configure_file (${SPHINX_CONF_IN} ${SPHINX_CONF_OUT} @ONLY )
123
+ # configure_file(${SPHINX_CONF_IN} ${SPHINX_CONF_OUT} @ONLY)
152
124
endfunction ()
153
125
154
126
function (_set_current_release )
@@ -192,8 +164,8 @@ endif()
192
164
# Set the location where the generated docs are saved
193
165
set (DOC_OUTPUT_DIR ${CMAKE_INSTALL_PREFIX} /docs )
194
166
195
- set (INDEX_NO_DOXYREST_IN ${CMAKE_CURRENT_SOURCE_DIR} /index_no_doxyrest.rst.in )
196
- set (INDEX_DOXYREST_IN ${CMAKE_CURRENT_SOURCE_DIR} /index_doxyrest.rst.in )
167
+ # set(INDEX_NO_DOXYREST_IN ${CMAKE_CURRENT_SOURCE_DIR}/index_no_doxyrest.rst.in)
168
+ # set(INDEX_DOXYREST_IN ${CMAKE_CURRENT_SOURCE_DIR}/index_doxyrest.rst.in)
197
169
set (INDEX_OUT ${CMAKE_CURRENT_SOURCE_DIR} /index.rst )
198
170
199
171
_set_current_release ()
@@ -207,6 +179,6 @@ set_property(
207
179
DIRECTORY
208
180
PROPERTY
209
181
ADDITIONAL_CLEAN_FILES
210
- "${CMAKE_CURRENT_SOURCE_DIR} /docfiles/ dpctl"
211
- "${CMAKE_CURRENT_SOURCE_DIR} /docfiles/ libsyclinterface"
182
+ "${CMAKE_CURRENT_SOURCE_DIR} /doc_sources/reference_guides/ dpctl/generated "
183
+ "${CMAKE_CURRENT_SOURCE_DIR} /doc_sources/reference_guides/ libsyclinterface/generated "
212
184
)
0 commit comments