Merge pull request #506 from VincentRouvreau/test_another_sphinx_themes

Test another sphinx themes

7 files changed, 76 insertions, 55 deletions

diff --git a/src/Bottleneck_distance/doc/perturb_pd.png b/src/Bottleneck_distance/doc/perturb_pd.png
index be638de0..eabf3c8c 100644
--- a/src/Bottleneck_distance/doc/perturb_pd.png
+++ b/src/Bottleneck_distance/doc/perturb_pd.png
diff --git a/src/cmake/modules/GUDHI_third_party_libraries.cmake b/src/cmake/modules/GUDHI_third_party_libraries.cmake
index e1566877..023061f1 100644
--- a/src/cmake/modules/GUDHI_third_party_libraries.cmake
+++ b/src/cmake/modules/GUDHI_third_party_libraries.cmake
@@ -156,6 +156,8 @@ if( PYTHONINTERP_FOUND )
   find_python_module("eagerpy")
   find_python_module_no_version("hnswlib")
   find_python_module("tensorflow")
+  find_python_module("sphinx_paramlinks")
+  find_python_module_no_version("python_docs_theme")
 endif()
 
 if(NOT GUDHI_PYTHON_PATH)
diff --git a/src/common/doc/header.html b/src/common/doc/header.html
index 9da20bbc..7c20478b 100644
--- a/src/common/doc/header.html
+++ b/src/common/doc/header.html
@@ -49,6 +49,7 @@ $extrastylesheet
                       <li><a  href="/relatedprojects/">Related projects</a></li>
                       <li><a  href="/theyaretalkingaboutus/">They are talking about us</a></li>
                       <li><a  href="/inaction/">GUDHI in action</a></li>
+                      <li><a  href="/etymology/">Etymology</a></li>
                   </ul>
               </li>
               <li class="divider"></li>
diff --git a/src/python/CMakeLists.txt b/src/python/CMakeLists.txt
index 98f2b85f..f534fc2a 100644
--- a/src/python/CMakeLists.txt
+++ b/src/python/CMakeLists.txt
@@ -107,6 +107,16 @@ if(PYTHONINTERP_FOUND)
     if(TENSORFLOW_FOUND)
       add_gudhi_debug_info("TensorFlow version ${TENSORFLOW_VERSION}")
     endif()
+    if(SPHINX_FOUND)
+      add_gudhi_debug_info("Sphinx version ${SPHINX_VERSION}")
+    endif()
+    if(SPHINX_PARAMLINKS_FOUND)
+      add_gudhi_debug_info("Sphinx-paramlinks version ${SPHINX_PARAMLINKS_VERSION}")
+    endif()
+    if(PYTHON_DOCS_THEME_FOUND)
+      # Does not have a version number...
+      add_gudhi_debug_info("python_docs_theme found")
+    endif()
 
     set(GUDHI_PYTHON_EXTRA_COMPILE_ARGS "${GUDHI_PYTHON_EXTRA_COMPILE_ARGS}'-DBOOST_RESULT_OF_USE_DECLTYPE', ")
     set(GUDHI_PYTHON_EXTRA_COMPILE_ARGS "${GUDHI_PYTHON_EXTRA_COMPILE_ARGS}'-DBOOST_ALL_NO_LIB', ")
@@ -281,62 +291,70 @@ if(PYTHONINTERP_FOUND)
   # Documentation generation is available through sphinx - requires all modules
   # Make it first as sphinx test is by far the longest test which is nice when testing in parallel
   if(SPHINX_PATH)
-    if(MATPLOTLIB_FOUND)
-      if(NUMPY_FOUND)
-        if(SCIPY_FOUND)
-          if(SKLEARN_FOUND)
-            if(OT_FOUND)
-              if(PYBIND11_FOUND)
-                if(NOT CGAL_WITH_EIGEN3_VERSION VERSION_LESS 4.11.0)
-                  set (GUDHI_SPHINX_MESSAGE "Generating API documentation with Sphinx in ${CMAKE_CURRENT_BINARY_DIR}/sphinx/")
-                  # User warning - Sphinx is a static pages generator, and configured to work fine with user_version
-                  # Images and biblio warnings because not found on developper version
-                  if (GUDHI_PYTHON_PATH STREQUAL "src/python")
-                    set (GUDHI_SPHINX_MESSAGE "${GUDHI_SPHINX_MESSAGE} \n WARNING : Sphinx is configured for user version, you run it on developper version. Images and biblio will miss")
-                  endif()
-                  # sphinx target requires gudhi.so, because conf.py reads gudhi version from it
-                  add_custom_target(sphinx
-                      WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doc
-                      COMMAND ${CMAKE_COMMAND} -E env "${GUDHI_PYTHON_PATH_ENV}"
-                      ${SPHINX_PATH} -b html ${CMAKE_CURRENT_SOURCE_DIR}/doc ${CMAKE_CURRENT_BINARY_DIR}/sphinx
-                      DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/gudhi.so"
-                      COMMENT "${GUDHI_SPHINX_MESSAGE}" VERBATIM)
-
-                  add_test(NAME sphinx_py_test
-                           WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-                           COMMAND ${CMAKE_COMMAND} -E env "${GUDHI_PYTHON_PATH_ENV}"
-                           ${SPHINX_PATH} -b doctest ${CMAKE_CURRENT_SOURCE_DIR}/doc ${CMAKE_CURRENT_BINARY_DIR}/doctest)
-
-                  # Set missing or not modules
-                  set(GUDHI_MODULES ${GUDHI_MODULES} "python-documentation" CACHE INTERNAL "GUDHI_MODULES")
-                else(NOT CGAL_WITH_EIGEN3_VERSION VERSION_LESS 4.11.0)
-                  message("++ Python documentation module will not be compiled because it requires a Eigen3 and CGAL version >= 4.11.0")
+    if(SPHINX_PARAMLINKS_FOUND)
+      if(PYTHON_DOCS_THEME_FOUND)
+        if(MATPLOTLIB_FOUND)
+          if(NUMPY_FOUND)
+            if(SCIPY_FOUND)
+              if(SKLEARN_FOUND)
+                if(OT_FOUND)
+                  if(PYBIND11_FOUND)
+                    if(NOT CGAL_WITH_EIGEN3_VERSION VERSION_LESS 4.11.0)
+                      set (GUDHI_SPHINX_MESSAGE "Generating API documentation with Sphinx in ${CMAKE_CURRENT_BINARY_DIR}/sphinx/")
+                      # User warning - Sphinx is a static pages generator, and configured to work fine with user_version
+                      # Images and biblio warnings because not found on developper version
+                      if (GUDHI_PYTHON_PATH STREQUAL "src/python")
+                        set (GUDHI_SPHINX_MESSAGE "${GUDHI_SPHINX_MESSAGE} \n WARNING : Sphinx is configured for user version, you run it on developper version. Images and biblio will miss")
+                      endif()
+                      # sphinx target requires gudhi.so, because conf.py reads gudhi version from it
+                      add_custom_target(sphinx
+                          WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doc
+                          COMMAND ${CMAKE_COMMAND} -E env "${GUDHI_PYTHON_PATH_ENV}"
+                          ${SPHINX_PATH} -b html ${CMAKE_CURRENT_SOURCE_DIR}/doc ${CMAKE_CURRENT_BINARY_DIR}/sphinx
+                          DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/gudhi.so"
+                          COMMENT "${GUDHI_SPHINX_MESSAGE}" VERBATIM)
+                      add_test(NAME sphinx_py_test
+                               WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+                               COMMAND ${CMAKE_COMMAND} -E env "${GUDHI_PYTHON_PATH_ENV}"
+                               ${SPHINX_PATH} -b doctest ${CMAKE_CURRENT_SOURCE_DIR}/doc ${CMAKE_CURRENT_BINARY_DIR}/doctest)
+                      # Set missing or not modules
+                      set(GUDHI_MODULES ${GUDHI_MODULES} "python-documentation" CACHE INTERNAL "GUDHI_MODULES")
+                    else(NOT CGAL_WITH_EIGEN3_VERSION VERSION_LESS 4.11.0)
+                      message("++ Python documentation module will not be compiled because it requires a Eigen3 and CGAL version >= 4.11.0")
+                      set(GUDHI_MISSING_MODULES ${GUDHI_MISSING_MODULES} "python-documentation" CACHE INTERNAL "GUDHI_MISSING_MODULES")
+                    endif(NOT CGAL_WITH_EIGEN3_VERSION VERSION_LESS 4.11.0)
+                  else(PYBIND11_FOUND)
+                    message("++ Python documentation module will not be compiled because pybind11 was not found")
+                    set(GUDHI_MISSING_MODULES ${GUDHI_MISSING_MODULES} "python-documentation" CACHE INTERNAL "GUDHI_MISSING_MODULES")
+                  endif(PYBIND11_FOUND)
+                else(OT_FOUND)
+                  message("++ Python documentation module will not be compiled because POT was not found")
                   set(GUDHI_MISSING_MODULES ${GUDHI_MISSING_MODULES} "python-documentation" CACHE INTERNAL "GUDHI_MISSING_MODULES")
-                endif(NOT CGAL_WITH_EIGEN3_VERSION VERSION_LESS 4.11.0)
-              else(PYBIND11_FOUND)
-                message("++ Python documentation module will not be compiled because pybind11 was not found")
+                endif(OT_FOUND)
+              else(SKLEARN_FOUND)
+                message("++ Python documentation module will not be compiled because scikit-learn was not found")
                 set(GUDHI_MISSING_MODULES ${GUDHI_MISSING_MODULES} "python-documentation" CACHE INTERNAL "GUDHI_MISSING_MODULES")
-              endif(PYBIND11_FOUND)
-            else(OT_FOUND)
-              message("++ Python documentation module will not be compiled because POT was not found")
+              endif(SKLEARN_FOUND)
+            else(SCIPY_FOUND)
+              message("++ Python documentation module will not be compiled because scipy was not found")
               set(GUDHI_MISSING_MODULES ${GUDHI_MISSING_MODULES} "python-documentation" CACHE INTERNAL "GUDHI_MISSING_MODULES")
-            endif(OT_FOUND)
-          else(SKLEARN_FOUND)
-            message("++ Python documentation module will not be compiled because scikit-learn was not found")
+            endif(SCIPY_FOUND)
+          else(NUMPY_FOUND)
+            message("++ Python documentation module will not be compiled because numpy was not found")
             set(GUDHI_MISSING_MODULES ${GUDHI_MISSING_MODULES} "python-documentation" CACHE INTERNAL "GUDHI_MISSING_MODULES")
-          endif(SKLEARN_FOUND)
-        else(SCIPY_FOUND)
-          message("++ Python documentation module will not be compiled because scipy was not found")
+          endif(NUMPY_FOUND)
+        else(MATPLOTLIB_FOUND)
+          message("++ Python documentation module will not be compiled because matplotlib was not found")
           set(GUDHI_MISSING_MODULES ${GUDHI_MISSING_MODULES} "python-documentation" CACHE INTERNAL "GUDHI_MISSING_MODULES")
-        endif(SCIPY_FOUND)
-      else(NUMPY_FOUND)
-        message("++ Python documentation module will not be compiled because numpy was not found")
+        endif(MATPLOTLIB_FOUND)
+      else(PYTHON_DOCS_THEME_FOUND)
+        message("++ Python documentation module will not be compiled because python-docs-theme was not found")
         set(GUDHI_MISSING_MODULES ${GUDHI_MISSING_MODULES} "python-documentation" CACHE INTERNAL "GUDHI_MISSING_MODULES")
-      endif(NUMPY_FOUND)
-    else(MATPLOTLIB_FOUND)
-      message("++ Python documentation module will not be compiled because matplotlib was not found")
+      endif(PYTHON_DOCS_THEME_FOUND)
+    else(SPHINX_PARAMLINKS_FOUND)
+      message("++ Python documentation module will not be compiled because sphinxcontrib-paramlinks was not found")
       set(GUDHI_MISSING_MODULES ${GUDHI_MISSING_MODULES} "python-documentation" CACHE INTERNAL "GUDHI_MISSING_MODULES")
-    endif(MATPLOTLIB_FOUND)
+    endif(SPHINX_PARAMLINKS_FOUND)
   else(SPHINX_PATH)
     message("++ Python documentation module will not be compiled because sphinx and sphinxcontrib-bibtex were not found")
     set(GUDHI_MISSING_MODULES ${GUDHI_MISSING_MODULES} "python-documentation" CACHE INTERNAL "GUDHI_MISSING_MODULES")
diff --git a/src/python/doc/_templates/layout.html b/src/python/doc/_templates/layout.html
index cd40a51b..e074b6c7 100644
--- a/src/python/doc/_templates/layout.html
+++ b/src/python/doc/_templates/layout.html
@@ -194,6 +194,7 @@
                         <li><a  href="/relatedprojects/">Related projects</a></li>
                         <li><a  href="/theyaretalkingaboutus/">They are talking about us</a></li>
                         <li><a  href="/inaction/">GUDHI in action</a></li>
+                        <li><a  href="/etymology/">Etymology</a></li>
                     </ul>
                 </li>
                 <li class="divider"></li>
diff --git a/src/python/doc/conf.py b/src/python/doc/conf.py
index b06baf9c..e69e2751 100755
--- a/src/python/doc/conf.py
+++ b/src/python/doc/conf.py
@@ -120,15 +120,12 @@ pygments_style = 'sphinx'
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'classic'
+html_theme = 'python_docs_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-     "sidebarbgcolor": "#A1ADCD",
-     "sidebartextcolor": "black",
-     "sidebarlinkcolor": "#334D5C",
      "body_max_width": "100%",
 }
 
diff --git a/src/python/doc/installation.rst b/src/python/doc/installation.rst
index 56f27b21..cb7700ce 100644
--- a/src/python/doc/installation.rst
+++ b/src/python/doc/installation.rst
@@ -194,8 +194,10 @@ A complete configuration would be :
 Documentation
 =============
 
-To build the documentation, `sphinx-doc <http://www.sphinx-doc.org>`_ and
-`sphinxcontrib-bibtex <https://sphinxcontrib-bibtex.readthedocs.io>`_ are
+To build the documentation, `sphinx-doc <http://www.sphinx-doc.org>`_,
+`sphinxcontrib-bibtex <https://sphinxcontrib-bibtex.readthedocs.io>`_,
+`sphinxcontrib-paramlinks <https://github.com/sqlalchemyorg/sphinx-paramlinks>`_ and
+`python-docs-theme <https://github.com/python/python-docs-theme>`_ are
 required. As the documentation is auto-tested, `CGAL`_, `Eigen`_,
 `Matplotlib`_, `NumPy`_, `POT`_, `Scikit-learn`_ and `SciPy`_ are
 also mandatory to build the documentation.