Skip to content

Commit 1917ad8

Browse files
Changed cmake script to build from new sources
1 parent 34cfc33 commit 1917ad8

File tree

2 files changed

+11
-37
lines changed

2 files changed

+11
-37
lines changed

docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ docfiles/dpctl
55
api
66
build
77
doxyrest-config.lua
8+
doc_sources/reference_guides/dpctl/generated
9+
doc_sources/reference_guides/libsyclinterface/generated

docs/CMakeLists.txt

Lines changed: 9 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -57,23 +57,22 @@ function(_setup_doxygen)
5757
endfunction()
5858

5959
function(_setup_doxyrest)
60-
set(DOXYREST_OUTPUT_DIR_NAME docfiles/libsyclinterface)
60+
set(DOXYREST_OUTPUT_RELATIVE_DIR_NAME doc_sources/reference_guides/libsyclinterface/generated)
6161
# Set the DOXYREST_OUTPUT_DIR variable in both current and parent scope.
6262
# The variable is used by _setup_sphinx when generating the conf.py file.
6363
set(DOXYREST_OUTPUT_DIR
64-
${CMAKE_CURRENT_SOURCE_DIR}/${DOXYREST_OUTPUT_DIR_NAME}
64+
${CMAKE_CURRENT_SOURCE_DIR}/${DOXYREST_OUTPUT_RELATIVE_DIR_NAME}
6565
PARENT_SCOPE
6666
)
6767
set(DOXYREST_OUTPUT_DIR
68-
${CMAKE_CURRENT_SOURCE_DIR}/${DOXYREST_OUTPUT_DIR_NAME}
68+
${CMAKE_CURRENT_SOURCE_DIR}/${DOXYREST_OUTPUT_RELATIVE_DIR_NAME}
6969
)
7070
set(DOXYREST_CONFIG_IN ${CMAKE_CURRENT_SOURCE_DIR}/doxyrest-config.lua.in)
7171
set(DOXYREST_CONFIG_OUT ${CMAKE_CURRENT_SOURCE_DIR}/doxyrest-config.lua)
7272
set(DOXYREST_OUTPUT ${DOXYREST_OUTPUT_DIR}/index.rst)
7373
set(DOXYGEN_OUTPUT_DIR ${DOC_OUTPUT_DIR}/doxygen)
7474

7575
configure_file(${DOXYREST_CONFIG_IN} ${DOXYREST_CONFIG_OUT} @ONLY)
76-
configure_file(${INDEX_DOXYREST_IN} ${INDEX_OUT} @ONLY)
7776

7877
add_custom_command(
7978
OUTPUT ${DOXYREST_OUTPUT}
@@ -83,7 +82,6 @@ function(_setup_doxyrest)
8382
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
8483
DEPENDS
8584
# Other docs files that can be edited manually
86-
${INDEX_OUT}
8785
${DOXYGEN_INDEX_FILE}
8886
MAIN_DEPENDENCY ${DOXYREST_CONFIG_OUT} ${DOXYREST_CONFIG_IN}
8987
COMMENT "Generating Doxyrest documentation"
@@ -96,46 +94,21 @@ function(_setup_doxyrest)
9694
endfunction()
9795

9896
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)
10398
set(SPHINX_OUTPUT_DIR ${DOC_OUTPUT_DIR}/docs)
10499
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)
108100

109101
if(DPCTL_ENABLE_DOXYREST)
110102
set(DEPEND_ON_DOXYREST "Doxyrest")
111-
else()
112-
configure_file(${INDEX_NO_DOXYREST_IN} ${INDEX_OUT} @ONLY)
113103
endif()
114104

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-
)
130105
add_custom_command(
131106
OUTPUT ${SPHINX_INDEX_FILE}
132107
COMMAND
133108
${SPHINX_EXECUTABLE} -b html
134109
${SPHINX_SOURCE}
135110
${SPHINX_OUTPUT_DIR}
136111
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
137-
DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/index.rst
138-
MAIN_DEPENDENCY ${SPHINX_CONF_OUT} ${SPHINX_CONF_IN}
139112
COMMENT "Generating Sphinx documentation"
140113
)
141114
# Target to generate Sphinx. Note that the order of the dependencies is
@@ -144,11 +117,10 @@ function(_setup_sphinx)
144117
Sphinx
145118
DEPENDS
146119
${DEPEND_ON_DOXYREST}
147-
${DPCTL_PYAPI_RST_FILE}
148120
${SPHINX_INDEX_FILE}
149121
)
150122
# 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)
152124
endfunction()
153125

154126
function(_set_current_release)
@@ -192,8 +164,8 @@ endif()
192164
# Set the location where the generated docs are saved
193165
set(DOC_OUTPUT_DIR ${CMAKE_INSTALL_PREFIX}/docs)
194166

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)
197169
set(INDEX_OUT ${CMAKE_CURRENT_SOURCE_DIR}/index.rst)
198170

199171
_set_current_release()
@@ -207,6 +179,6 @@ set_property(
207179
DIRECTORY
208180
PROPERTY
209181
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"
212184
)

0 commit comments

Comments
 (0)