mirror of
https://github.com/mpusz/mp-units.git
synced 2025-08-04 20:54:28 +02:00
Option to disable documentation generation added
This commit is contained in:
@@ -20,9 +20,14 @@
|
||||
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
# SOFTWARE.
|
||||
|
||||
option(GENERATE_DOCS "Generate project documenation" ON)
|
||||
if(NOT GENERATE_DOCS)
|
||||
return()
|
||||
endif()
|
||||
|
||||
find_package(Doxygen REQUIRED)
|
||||
find_package(Sphinx REQUIRED)
|
||||
|
||||
|
||||
set(DOXYGEN_INPUT_DIR "${PROJECT_SOURCE_DIR}/src")
|
||||
set(DOXYGEN_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/doxygen")
|
||||
set(DOXYGEN_INDEX_FILE "${DOXYGEN_OUTPUT_DIR}/xml/index.xml")
|
||||
@@ -45,10 +50,10 @@ add_custom_command(OUTPUT "${DOXYGEN_INDEX_FILE}"
|
||||
MAIN_DEPENDENCY "${DOXYFILE_OUT}" "${DOXYFILE_IN}"
|
||||
COMMENT "Generating doxygen XML metadata"
|
||||
VERBATIM)
|
||||
|
||||
|
||||
# Nice named target so we can run the job easily
|
||||
add_custom_target(doxygen ALL DEPENDS "${DOXYGEN_INDEX_FILE}")
|
||||
|
||||
|
||||
set(SPHINX_SOURCE "${CMAKE_CURRENT_SOURCE_DIR}")
|
||||
set(SPHINX_BUILD "${CMAKE_CURRENT_BINARY_DIR}/sphinx")
|
||||
set(SPHINX_INDEX_FILE "${SPHINX_BUILD}/index.html")
|
||||
@@ -225,10 +230,10 @@ add_custom_command(OUTPUT "${SPHINX_INDEX_FILE}"
|
||||
"${DOXYGEN_INDEX_FILE}"
|
||||
MAIN_DEPENDENCY "${SPHINX_SOURCE}/conf.py"
|
||||
COMMENT "Generating documentation with Sphinx")
|
||||
|
||||
|
||||
# Nice named target so we can run the job easily
|
||||
add_custom_target(sphinx ALL DEPENDS ${SPHINX_INDEX_FILE})
|
||||
|
||||
|
||||
# Add an install target to install the docs
|
||||
include(GNUInstallDirs)
|
||||
install(DIRECTORY ${SPHINX_BUILD}
|
||||
|
Reference in New Issue
Block a user