Merge branch 'master' of github.com:TartanLlama/cpp-documentation-example

Author: TartanLlama

CMakeLists.txt

@@ -2,6 +2,7 @@
 
 project ("CatCutifier")
 
+# Add the cmake folder so the FindSphinx module is found
 set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
 
 add_subdirectory ("CatCutifier")

README.md

@@ -2,3 +2,10 @@
 An example of setting up CMake + Sphinx + Read the Docs for C++
 
 See the documentation [here](https://cpp-documentation-example.readthedocs.io/en/latest/)
+
+## Dependencies
+
+- [Doxygen](http://www.doxygen.nl/download.html)
+- [Sphinx](https://www.sphinx-doc.org/en/master/usage/installation.html)
+- [Breathe](https://pypi.org/project/breathe/)
+- [sphinx_rtd_theme](https://github.com/rtfd/sphinx_rtd_theme)

docs/CMakeLists.txt

@@ -21,9 +21,9 @@ file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR})
 # Only regenerate Doxygen when the Doxyfile or public headers change
 add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE}
 		DEPENDS ${CAT_CUTIFIER_PUBLIC_HEADERS}
-        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
+        	COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
 		MAIN_DEPENDENCY ${DOXYFILE_OUT} ${DOXYFILE_IN}
-        COMMENT "Generating docs"
+        	COMMENT "Generating docs"
 		VERBATIM)
 
 # Nice named target so we can run the job easily
@@ -56,4 +56,4 @@ add_custom_target(Sphinx ALL DEPENDS ${SPHINX_INDEX_FILE})
 
 include(GNUInstallDirs)
 install(DIRECTORY ${SPHINX_BUILD}
-		DESTINATION ${CMAKE_INSTALL_DOCDIR})
+	DESTINATION ${CMAKE_INSTALL_DOCDIR})