Attempt to use CMake on ReadTheDocs...

soasis · Feb 11, 2021 · 20f802a · 20f802a
1 parent a6bc087
commit 20f802a
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 10 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,20 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: documentation/conf.py
+
+# Optionally build your docs in additional formats such as PDF
+formats:
+   - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+   version: 3.7
+   install:
+   - requirements: documentation/requirements.txt
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -78,6 +78,7 @@ include(GNUInstallDirs)
 option(ZTD_TEXT_CI "Whether or not we are in continuous integration mode" OFF)
 option(ZTD_TEXT_TESTS "Enable build of tests" OFF)
 option(ZTD_TEXT_DOCUMENTATION "Enable build of documentation" OFF)
+option(ZTD_TEXT_DOCUMENTATION_NO_SPHINX "Turn off Sphinx usage (useful for ReadTheDocs builds)" OFF)
 option(ZTD_TEXT_EXAMPLES "Enable build of examples" OFF)
 option(ZTD_TEXT_BENCHMARKS "Enable build of benchmarks" OFF)
 option(ZTD_TEXT_GENERATE_SINGLE "Enable generation of a single header and its target" OFF)

diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt
@@ -29,7 +29,9 @@
 
 find_package(Doxygen REQUIRED)
 find_package(Python3 REQUIRED)
-find_package(Sphinx REQUIRED)
+if (NOT ZTD_TEXT_DOCUMENTATION_NO_SPHINX)
+	find_package(Sphinx REQUIRED)
+endif()
 
 # Find all the public headers
 file(GLOB_RECURSE ztd_text_public_headers LIST_DIRECTORIES false CONFIGURE_DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/../include/**.*)
@@ -63,23 +65,28 @@ configure_file(${ZTD_TEXT_DOXYFILE_IN} ${ZTD_TEXT_DOXYFILE_OUT} @ONLY)
 
 # Ensure Doxygen won't crash because it doesn't create directories for us
 file(MAKE_DIRECTORY ${ZTD_TEXT_DOXYGEN_OUTPUT_DIR})
+file(MAKE_DIRECTORY ${ZTD_TEXT_DOXYGEN_XML_OUTPUT_DIR})
+file(MAKE_DIRECTORY ${ZTD_TEXT_DOXYGEN_HTML_OUTPUT_DIR})
 
 add_custom_command(OUTPUT ${ZTD_TEXT_DOXYGEN_INDEX_FILE}
 	COMMAND ${DOXYGEN_EXECUTABLE} ${ZTD_TEXT_DOXYFILE_OUT}
 	MAIN_DEPENDENCY ${ZTD_TEXT_DOXYFILE_IN} ${ZTD_TEXT_DOXYFILE_OUT}
 	DEPENDS ${ztd_text_public_headers}
 	COMMENT "[ztd.text/documentation] Generating Doxygen XML..."
 )
-add_custom_target(ztd.text.documentation.doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE})
+add_custom_target(ztd.text.documentation.doxygen ALL DEPENDS ${ZTD_TEXT_DOXYGEN_INDEX_FILE})
 
-add_custom_target(ztd.text.documentation.sphinx ALL
-	COMMAND ${SPHINX_EXECUTABLE} -b html ${ZTD_TEXT_SPHINX_SOURCE_DIR} ${ZTD_TEXT_SPHINX_BUILD_DIR}
-		-Dbreathe_projects.ztd.text=${ZTD_TEXT_DOXYGEN_XML_OUTPUT_DIR}
-	WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-	DEPENDS ${ZTD_TEXT_DOXYGEN_INDEX_FILE} ${ztd_text_sphinx_sources}
-	COMMENT "[ztd.text/documentation] Generating Sphinx documentation..."
-)
-add_dependencies(ztd.text.documentation.sphinx ztd.text.documentation.doxygen)
+if (NOT ZTD_TEXT_DOCUMENTATION_NO_SPHINX)
+	add_custom_target(ztd.text.documentation.sphinx ALL
+		COMMAND ${SPHINX_EXECUTABLE} -b html ${ZTD_TEXT_SPHINX_SOURCE_DIR} ${ZTD_TEXT_SPHINX_BUILD_DIR}
+			-Dbreathe_projects.ztd.text=${ZTD_TEXT_DOXYGEN_XML_OUTPUT_DIR}
+		WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+		DEPENDS ${ZTD_TEXT_DOXYGEN_INDEX_FILE} ${ztd_text_sphinx_sources}
+		COMMENT "[ztd.text/documentation] Generating Sphinx documentation..."
+	)
+
+	add_dependencies(ztd.text.documentation.sphinx ztd.text.documentation.doxygen)
+endif()
 
 # For the install target
 include(GNUInstallDirs)

diff --git a/documentation/requirements.txt b/documentation/requirements.txt
@@ -1 +1,3 @@
 breathe
+cmake
+ninja
diff --git a/documentation/source/conf.py b/documentation/source/conf.py
@@ -68,4 +68,20 @@
 
 # Breathe Configuration
 #
+breathe_projects = {}
 breathe_default_project = "ztd.text"
+
+
+# ReadTheDocs Build Help
+#
+def run_cmake_doxygen():
+	os.mkdir('build')
+	subprocess.call("cmake -DZTD_TEXT_DOCUMENTATION:BOOL=TRUE -DZTD_TEXT_DOCUMENTATION_NO_SPHINX:BOOL=TRUE ../..", shell=True, cwd='build')
+	subprocess.call("cmake --build .", shell=True, cwd='build')
+	breathe_projects["ztd.text"] = 'build/doxygen/xml'
+
+
+# Are we on the ReadTheDocs server?
+read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
+if read_the_docs_build:
+	run_cmake_doxygen()