Adding sphinx to target doc2 cmake build

phoebe-team · Dec 11, 2020 · 0cd5ac4 · 0cd5ac4
1 parent 7e341a5
commit 0cd5ac4
Show file tree

Hide file tree

Showing 30 changed files with 37 additions and 5 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -13,6 +13,9 @@ set(CMAKE_CXX_STANDARD 14)
 
 project(Phoebe C CXX Fortran)
 
+## load custom cmake find_package
+set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
+
 if(CMAKE_CXX_COMPILER_ID MATCHES GNU)
     SET(GCC_COVERAGE_COMPILE_FLAGS "-Wall -Wextra -ggdb -fno-omit-frame-pointer -Wno-deprecated-copy -Wno-ignored-attributes")
     add_definitions(${GCC_COVERAGE_COMPILE_FLAGS})
@@ -144,14 +147,15 @@ endif()
 ############# DOCS ############
 
 find_package(Doxygen)
+find_package(Sphinx)
 
 IF (BUILD_DOC)
     IF (NOT DOXYGEN_FOUND)
         message("Doxygen need to be installed to generate the doxygen documentation")
     else()
         # set input and output files
-        set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/doc/Doxyfile)
-        set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/doc/Doxyfile.out)
+        set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/doc/doxygen/Doxyfile)
+        set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/doc/doxygen/Doxyfile.out)
 
         # request to configure the file
         configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
@@ -161,9 +165,22 @@ IF (BUILD_DOC)
         add_custom_target(
             doc
             COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_IN}
-            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../doc
+            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../doc/doxygen
             COMMENT "Generating API documentation with Doxygen"
             VERBATIM)
+
+	IF (NOT SPHINX_FOUND)
+	  message("Documentation needs also sphinx")
+	else()		
+	  add_custom_target(
+	    doc2
+	    COMMAND make html
+	    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/../doc/sphinx
+	    COMMENT "Building user documentation with Sphinx"
+	    VERBATIM)
+	endif()
     ENDIF()
 endif()
 
+
+
diff --git a/cmake/FindSphinx.cmake b/cmake/FindSphinx.cmake
@@ -0,0 +1,14 @@
+find_program(SPHINX_EXECUTABLE NAMES sphinx-build
+    HINTS
+    $ENV{SPHINX_DIR}
+    PATH_SUFFIXES bin
+    DOC "Sphinx documentation generator"
+)
+
+include(FindPackageHandleStandardArgs)
+
+find_package_handle_standard_args(Sphinx DEFAULT_MSG
+    SPHINX_EXECUTABLE
+)
+
+mark_as_advanced(SPHINX_EXECUTABLE)
diff --git a/doc/Doxyfile → doc/doxygen/Doxyfile b/doc/Doxyfile → doc/doxygen/Doxyfile
@@ -832,7 +832,7 @@ WARN_LOGFILE           =
 INPUT = ./doc_pages/developerOverview.md \
 	./doc_pages/Units.md \
 	./doc_pages/UnitTesting.md \
-	../src/ 
+	../../src/ 
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/doc/doc_pages/UnitTesting.md → doc/doxygen/doc_pages/UnitTesting.md b/doc/doc_pages/UnitTesting.md → doc/doxygen/doc_pages/UnitTesting.md
diff --git a/doc/doc_pages/Units.md → doc/doxygen/doc_pages/Units.md b/doc/doc_pages/Units.md → doc/doxygen/doc_pages/Units.md
diff --git a/doc/doc_pages/developerOverview.md → doc/doxygen/doc_pages/developerOverview.md b/doc/doc_pages/developerOverview.md → doc/doxygen/doc_pages/developerOverview.md
diff --git a/doc/images/Logo.png → doc/doxygen/images/Logo.png b/doc/images/Logo.png → doc/doxygen/images/Logo.png
diff --git a/doc/images/TransportCode.drawio → doc/doxygen/images/TransportCode.drawio b/doc/images/TransportCode.drawio → doc/doxygen/images/TransportCode.drawio
diff --git a/doc/images/TransportCode.html → doc/doxygen/images/TransportCode.html b/doc/images/TransportCode.html → doc/doxygen/images/TransportCode.html
diff --git a/doc/images/TransportCode.png → doc/doxygen/images/TransportCode.png b/doc/images/TransportCode.png → doc/doxygen/images/TransportCode.png
diff --git a/doc/Makefile → doc/sphinx/Makefile b/doc/Makefile → doc/sphinx/Makefile
diff --git a/doc/make.bat → doc/sphinx/make.bat b/doc/make.bat → doc/sphinx/make.bat
diff --git a/doc/source/conf.py → doc/sphinx/source/conf.py b/doc/source/conf.py → doc/sphinx/source/conf.py
diff --git a/doc/source/index.rst → doc/sphinx/source/index.rst b/doc/source/index.rst → doc/sphinx/source/index.rst
@@ -14,7 +14,7 @@ Welcome to Phoebe's documentation!
    postProcessing
    tutorials/tutorials
    theory/theory
-   Developers' documentation <../../html/index.html#http://>
+   Developers' documentation <../../../doxygen/html/index.html#http://>
 
 This is the documentation of Phoebe's project.
 

diff --git a/doc/source/inputFiles.rst → doc/sphinx/source/inputFiles.rst b/doc/source/inputFiles.rst → doc/sphinx/source/inputFiles.rst
diff --git a/doc/source/installation.rst → doc/sphinx/source/installation.rst b/doc/source/installation.rst → doc/sphinx/source/installation.rst
diff --git a/doc/source/introduction.rst → doc/sphinx/source/introduction.rst b/doc/source/introduction.rst → doc/sphinx/source/introduction.rst
diff --git a/doc/source/postProcessing.rst → doc/sphinx/source/postProcessing.rst b/doc/source/postProcessing.rst → doc/sphinx/source/postProcessing.rst
diff --git a/doc/source/running.rst → doc/sphinx/source/running.rst b/doc/source/running.rst → doc/sphinx/source/running.rst
diff --git a/doc/source/theory/dynamicalMatrix.rst → doc/sphinx/source/theory/dynamicalMatrix.rst b/doc/source/theory/dynamicalMatrix.rst → doc/sphinx/source/theory/dynamicalMatrix.rst
diff --git a/doc/source/theory/fourierInterpolation.rst → ...nx/source/theory/fourierInterpolation.rst b/doc/source/theory/fourierInterpolation.rst → ...nx/source/theory/fourierInterpolation.rst
diff --git a/doc/source/theory/phononBTE.rst → doc/sphinx/source/theory/phononBTE.rst b/doc/source/theory/phononBTE.rst → doc/sphinx/source/theory/phononBTE.rst
diff --git a/doc/source/theory/statistics.rst → doc/sphinx/source/theory/statistics.rst b/doc/source/theory/statistics.rst → doc/sphinx/source/theory/statistics.rst
diff --git a/doc/source/theory/thEpa.rst → doc/sphinx/source/theory/thEpa.rst b/doc/source/theory/thEpa.rst → doc/sphinx/source/theory/thEpa.rst
diff --git a/doc/source/theory/theory.rst → doc/sphinx/source/theory/theory.rst b/doc/source/theory/theory.rst → doc/sphinx/source/theory/theory.rst
diff --git a/doc/source/theory/wannier.rst → doc/sphinx/source/theory/wannier.rst b/doc/source/theory/wannier.rst → doc/sphinx/source/theory/wannier.rst
diff --git a/doc/source/tutorials/elEpaTransport.rst → ...phinx/source/tutorials/elEpaTransport.rst b/doc/source/tutorials/elEpaTransport.rst → ...phinx/source/tutorials/elEpaTransport.rst
@@ -157,6 +157,7 @@ On top of that, you should also see several files named as `{prefix}.phoebe.****
 These files contain the values of the electron-phonon coupling that will be used by Phoebe.
 
 *Current limitations:*
+
 * There are restrictions to the choice of k and q points.
   The `K_POINTS` in `pw.x` must be `automatic`. The `K_POINTS` must be gamma centered.
   And the q-point mesh must be the same as the k-point mesh.

diff --git a/doc/source/tutorials/elWanTransport.rst → ...phinx/source/tutorials/elWanTransport.rst b/doc/source/tutorials/elWanTransport.rst → ...phinx/source/tutorials/elWanTransport.rst
diff --git a/doc/source/tutorials/phononTransport.rst → ...hinx/source/tutorials/phononTransport.rst b/doc/source/tutorials/phononTransport.rst → ...hinx/source/tutorials/phononTransport.rst
diff --git a/doc/source/tutorials/tutorials.rst → doc/sphinx/source/tutorials/tutorials.rst b/doc/source/tutorials/tutorials.rst → doc/sphinx/source/tutorials/tutorials.rst