feedc0de/mp-units
1
0
Fork 0
forked from mpusz/mp-units
Code Pull Requests Activity

Option to disable documentation generation added

Browse Source
This commit is contained in:
Mateusz Pusz
2020-06-16 17:44:07 +02:00
parent 54df464b1d
commit 50623e492e
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/CMakeLists.txt
View File

@@ -20,9 +20,14 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE. # SOFTWARE.
option(GENERATE_DOCS "Generate project documenation" ON)
if(NOT GENERATE_DOCS)
return()
endif()
find_package(Doxygen REQUIRED) find_package(Doxygen REQUIRED)
find_package(Sphinx REQUIRED) find_package(Sphinx REQUIRED)
set(DOXYGEN_INPUT_DIR "${PROJECT_SOURCE_DIR}/src") set(DOXYGEN_INPUT_DIR "${PROJECT_SOURCE_DIR}/src")
set(DOXYGEN_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/doxygen") set(DOXYGEN_OUTPUT_DIR "${CMAKE_CURRENT_BINARY_DIR}/doxygen")
set(DOXYGEN_INDEX_FILE "${DOXYGEN_OUTPUT_DIR}/xml/index.xml") 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}" MAIN_DEPENDENCY "${DOXYFILE_OUT}" "${DOXYFILE_IN}"
COMMENT "Generating doxygen XML metadata" COMMENT "Generating doxygen XML metadata"
VERBATIM) VERBATIM)
# Nice named target so we can run the job easily # Nice named target so we can run the job easily
add_custom_target(doxygen ALL DEPENDS "${DOXYGEN_INDEX_FILE}") add_custom_target(doxygen ALL DEPENDS "${DOXYGEN_INDEX_FILE}")
set(SPHINX_SOURCE "${CMAKE_CURRENT_SOURCE_DIR}") set(SPHINX_SOURCE "${CMAKE_CURRENT_SOURCE_DIR}")
set(SPHINX_BUILD "${CMAKE_CURRENT_BINARY_DIR}/sphinx") set(SPHINX_BUILD "${CMAKE_CURRENT_BINARY_DIR}/sphinx")
set(SPHINX_INDEX_FILE "${SPHINX_BUILD}/index.html") set(SPHINX_INDEX_FILE "${SPHINX_BUILD}/index.html")
@@ -225,10 +230,10 @@ add_custom_command(OUTPUT "${SPHINX_INDEX_FILE}"
"${DOXYGEN_INDEX_FILE}" "${DOXYGEN_INDEX_FILE}"
MAIN_DEPENDENCY "${SPHINX_SOURCE}/conf.py" MAIN_DEPENDENCY "${SPHINX_SOURCE}/conf.py"
COMMENT "Generating documentation with Sphinx") COMMENT "Generating documentation with Sphinx")
# Nice named target so we can run the job easily # Nice named target so we can run the job easily
add_custom_target(sphinx ALL DEPENDS ${SPHINX_INDEX_FILE}) add_custom_target(sphinx ALL DEPENDS ${SPHINX_INDEX_FILE})
# Add an install target to install the docs # Add an install target to install the docs
include(GNUInstallDirs) include(GNUInstallDirs)
install(DIRECTORY ${SPHINX_BUILD} install(DIRECTORY ${SPHINX_BUILD}