Skip to content

Commit bd2c345

Browse files
committed
Fix publish-docs to keep artifacts out of the committed html
There were .doctree cache artifacts being included in the 'doc/html', 'doc/html/pdf', and 'doc/html/epub' folders that are only used during Sphinx generation of the content. Moves the location of these files to a common location in the build/doc folder outside of the html folder to be committed. This should have the added benefit of reducing the workload, since all three versions use can share the same cache files. Signed-off-by: Winford <winford@object.stream>
1 parent db571ac commit bd2c345

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/CMakeLists.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,21 +135,21 @@ if(SPHINX_FOUND)
135135
file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/pdf_template.rtt DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/)
136136
file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/apidocs/libatomvm)
137137
add_custom_target(sphinx-html
138-
${SPHINX_BUILD_EXECUTABLE} -q -b html -c ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/src/ ${CMAKE_CURRENT_BINARY_DIR}/html/
138+
${SPHINX_BUILD_EXECUTABLE} -q --doctree-dir ${CMAKE_CURRENT_BINARY_DIR}/doctree -b html -c ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/src/ ${CMAKE_CURRENT_BINARY_DIR}/html/
139139
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
140140
COMMENT "Generating Sphinx HTML documentation" VERBATIM
141141
DEPENDS ${DOTFILE_TARGETS} ${ERLANG_EDOC_TARGETS}
142142
)
143143

144144
add_custom_target(sphinx-pdf
145-
${SPHINX_BUILD_EXECUTABLE} -q -D exclude_patterns=apidocs/libatomvm/** -b rinoh -c ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/src/ ${CMAKE_CURRENT_BINARY_DIR}/pdf/
145+
${SPHINX_BUILD_EXECUTABLE} -q --doctree-dir ${CMAKE_CURRENT_BINARY_DIR}/doctree -D exclude_patterns=apidocs/libatomvm/** -b rinoh -c ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/src/ ${CMAKE_CURRENT_BINARY_DIR}/pdf/
146146
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
147147
COMMENT "Generating Sphinx PDF documentation" VERBATIM
148148
DEPENDS ${DOTFILE_TARGETS} ${ERLANG_EDOC_TARGETS}
149149
)
150150

151151
add_custom_target(sphinx-epub
152-
${SPHINX_BUILD_EXECUTABLE} -q -D exclude_patterns=apidocs/libatomvm/**,LICENSES/** -b epub -c ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/src/ ${CMAKE_CURRENT_BINARY_DIR}/epub/
152+
${SPHINX_BUILD_EXECUTABLE} -q --doctree-dir ${CMAKE_CURRENT_BINARY_DIR}/doctree -D exclude_patterns=apidocs/libatomvm/**,LICENSES/** -b epub -c ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/src/ ${CMAKE_CURRENT_BINARY_DIR}/epub/
153153
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
154154
COMMENT "Generating Sphinx EPub documentation" VERBATIM
155155
DEPENDS ${DOTFILE_TARGETS} ${ERLANG_EDOC_TARGETS}

0 commit comments

Comments
 (0)