summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArcturus Arcturus <arcturus98@outlook.com>2021-09-16 11:55:12 (GMT)
committerBrad King <brad.king@kitware.com>2021-10-04 15:33:42 (GMT)
commit1d03aa841c38ea19ffdab08f762fa39d4134874c (patch)
tree192b0e26865a196105883200b3dca482d2cf4a1d
parent8dee2c3aee3495fcb4df3f41e4a31aa7ffc38567 (diff)
downloadCMake-1d03aa841c38ea19ffdab08f762fa39d4134874c.zip
CMake-1d03aa841c38ea19ffdab08f762fa39d4134874c.tar.gz
CMake-1d03aa841c38ea19ffdab08f762fa39d4134874c.tar.bz2
Utilities/Sphinx: Print path to index.html in build output
Print the url to index.html in the build output, just so one can "open in browser" from the context menu in some terminals.
-rw-r--r--Utilities/Sphinx/CMakeLists.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/Utilities/Sphinx/CMakeLists.txt b/Utilities/Sphinx/CMakeLists.txt
index a71dfcd..c8a970d 100644
--- a/Utilities/Sphinx/CMakeLists.txt
+++ b/Utilities/Sphinx/CMakeLists.txt
@@ -58,6 +58,13 @@ configure_file(conf.py.in conf.py @ONLY)
set(doc_formats "")
if(SPHINX_HTML)
list(APPEND doc_formats html)
+
+ # we provide the path to the produced html output in the console
+ # for tools that support URI protocol schemes
+ set(html_extra_commands
+ COMMAND ${CMAKE_COMMAND} -E echo "sphinx-build html: HTML documentation generated in file://${CMAKE_CURRENT_BINARY_DIR}/html/index.html"
+ )
+
endif()
if(SPHINX_MAN)
list(APPEND doc_formats man)