require at least python 3.5 for building docs and import CMake improvements from progguide branch (ec6d3586) · Commits · 郑智淋 / lammps

cmake/Modules/Documentation.cmake

+26 −11

Original line number	Diff line number	Diff line
		@@ -2,10 +2,19 @@
		# Build documentation
		###############################################################################
		option(BUILD_DOC "Build LAMMPS HTML documentation" OFF)
		if(BUILD_DOC)
		find_package(PythonInterp 3 REQUIRED)

		set(VIRTUALENV ${PYTHON_EXECUTABLE} -m virtualenv)
		if(BUILD_DOC)
		# Sphinx 3.x requires at least Python 3.5
		if(CMAKE_VERSION VERSION_LESS 3.12)
		find_package(PythonInterp 3.5 REQUIRED)
		set(VIRTUALENV ${PYTHON_EXECUTABLE} -m virtualenv -p ${PYTHON_EXECUTABLE})
		else()
		find_package(Python3 REQUIRED COMPONENTS Interpreter)
		if(Python3_VERSION VERSION_LESS 3.5)
		message(FATAL_ERROR "Python 3.5 and up is required to build the HTML documentation")
		endif()
		set(VIRTUALENV ${Python3_EXECUTABLE} -m virtualenv -p ${Python3_EXECUTABLE})
		endif()

		file(GLOB DOC_SOURCES ${LAMMPS_DOC_DIR}/src/[^.]*.rst)

		@@ -25,11 +34,10 @@ if(BUILD_DOC)
		)

		# download mathjax distribution and unpack to folder "mathjax"
		if(NOT EXISTS ${CMAKE_CURRENT_BINARY_DIR}/mathjax/es5)
		file(DOWNLOAD "https://github.com/mathjax/MathJax/archive/3.0.5.tar.gz"
		"${CMAKE_CURRENT_BINARY_DIR}/mathjax.tar.gz"
		EXPECTED_MD5 5d9d3799cce77a1a95eee6be04eb68e7)

		if(NOT EXISTS ${CMAKE_CURRENT_BINARY_DIR}/mathjax)
		execute_process(COMMAND ${CMAKE_COMMAND} -E tar xzf mathjax.tar.gz WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
		file(GLOB MATHJAX_VERSION_DIR ${CMAKE_CURRENT_BINARY_DIR}/MathJax-*)
		execute_process(COMMAND ${CMAKE_COMMAND} -E rename ${MATHJAX_VERSION_DIR} ${CMAKE_CURRENT_BINARY_DIR}/mathjax)
		@@ -37,11 +45,18 @@ if(BUILD_DOC)
		file(MAKE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/_static/mathjax)
		file(COPY ${CMAKE_CURRENT_BINARY_DIR}/mathjax/es5 DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/html/_static/mathjax/)

		# for increased browser compatibility
		if(NOT EXISTS ${CMAKE_CURRENT_BINARY_DIR}/html/_static/polyfill.js)
		file(DOWNLOAD "https://polyfill.io/v3/polyfill.min.js?features=es6"
		"${CMAKE_CURRENT_BINARY_DIR}/html/_static/polyfill.js")
		endif()

		# note, this may run in parallel with other tasks, so we must not use multiple processes here
		add_custom_command(
		OUTPUT html
		DEPENDS ${DOC_SOURCES} docenv requirements.txt
		COMMAND ${DOCENV_BINARY_DIR}/sphinx-build -b html -c ${LAMMPS_DOC_DIR}/utils/sphinx-config -d ${CMAKE_BINARY_DIR}/doctrees ${LAMMPS_DOC_DIR}/src html
		COMMAND ${CMAKE_COMMAND} -E create_symlink Manual.html ${CMAKE_CURRENT_BINARY_DIR}/html/index.html
		)

		# copy selected image files to html output tree
		@@ -56,17 +71,17 @@ if(BUILD_DOC)
		set(HTML_IMAGE_TARGETS "")
		foreach(_IMG ${HTML_EXTRA_IMAGES})
		string(PREPEND _IMG JPG/)
		list(APPEND HTML_IMAGE_TARGETS "html/${_IMG}")
		list(APPEND HTML_IMAGE_TARGETS "${CMAKE_CURRENT_BINARY_DIR}/html/${_IMG}")
		add_custom_command(
		OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/html/${_IMG}
		DEPENDS ${LAMMPS_DOC_DIR}/src/${_IMG} html/JPG
		DEPENDS ${LAMMPS_DOC_DIR}/src/${_IMG} ${CMAKE_CURRENT_BINARY_DIR}/html/JPG
		COMMAND ${CMAKE_COMMAND} -E copy ${LAMMPS_DOC_DIR}/src/${_IMG} ${CMAKE_BINARY_DIR}/html/${_IMG}
		)
		endforeach()

		add_custom_target(
		doc ALL
		DEPENDS html html/_static/mathjax/es5 ${HTML_IMAGE_TARGETS}
		DEPENDS html ${CMAKE_CURRENT_BINARY_DIR}/html/_static/mathjax/es5 ${HTML_IMAGE_TARGETS}
		SOURCES ${LAMMPS_DOC_DIR}/utils/requirements.txt ${DOC_SOURCES}
		)

Admin message