Skip to content

Move the manual EXCLUDE_FROM_ALL inwards #3111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Move the manual EXCLUDE_FROM_ALL inwards #3111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5d37597
Move the `EXCLUDE_FROM_ALL` inwards in the manual
LecrisUT Jun 23, 2025
51bef96
Fix the environment setting
LecrisUT Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -733,7 +733,7 @@ endif()

option(BOUT_BUILD_DOCS "Build the documentation" OFF)
if (BOUT_BUILD_DOCS)
add_subdirectory(manual EXCLUDE_FROM_ALL)
add_subdirectory(manual)
endif()


Expand Down
15 changes: 10 additions & 5 deletions manual/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,33 @@ find_package(Sphinx REQUIRED)
set(BOUT_SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR}/sphinx)
set(BOUT_SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/docs)

set(env_command
${CMAKE_COMMAND} -E env
PYTHONPATH=${BOUT_PYTHONPATH}:$ENV{PYTHONPATH}
)

add_custom_target(sphinx-html
COMMAND ${env_command}
COMMAND ${SPHINX_EXECUTABLE} -b html ${BOUT_SPHINX_SOURCE} ${BOUT_SPHINX_BUILD}
COMMAND ${CMAKE_COMMAND} -E echo "Generated HTML docs in file://${BOUT_SPHINX_BUILD}/index.html"
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating HTML documentation with Sphinx in ${BOUT_SPHINX_BUILD}"
)

add_custom_target(sphinx-pdf
COMMAND ${env_command}
COMMAND ${SPHINX_EXECUTABLE} -M latexpdf ${BOUT_SPHINX_SOURCE} ${BOUT_SPHINX_BUILD}
COMMAND ${CMAKE_COMMAND} -E echo "Generated PDF docs in file://${BOUT_SPHINX_BUILD}"
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating PDF documentation with Sphinx in ${BOUT_SPHINX_BUILD}"
)

set_target_properties(sphinx-html sphinx-pdf PROPERTIES
ENVIRONMENT PYTHONPATH=${BOUT_PYTHONPATH}:$ENV{PYTHONPATH}
)

add_custom_target(docs ALL)
add_custom_target(docs)
add_dependencies(docs sphinx-html)

install(DIRECTORY ${BOUT_SPHINX_BUILD}/
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/doc/bout++/
EXCLUDE_FROM_ALL
COMPONENT docs
PATTERN .* EXCLUDE
)