You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by as...@apache.org on 2019/08/28 21:23:39 UTC

[qpid-proton] branch master updated: PROTON-2086: Fix small errors in python sphinx doc build process - Actually need both sphinx and sphinx_automodapi for doc generation - There was an error in the cmake code if sphinx wasn't detected We don't need a specific message telling us the python version tried as it will always be the python version detected earlier by CMake.

This is an automated email from the ASF dual-hosted git repository.

astitcher pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/qpid-proton.git


The following commit(s) were added to refs/heads/master by this push:
     new ee22a18  PROTON-2086: Fix small errors in python sphinx doc build process - Actually need both sphinx and sphinx_automodapi for doc generation - There was an error in the cmake code if sphinx wasn't detected   We don't need a specific message telling us the python version tried as it   will always be the python version detected earlier by CMake.
ee22a18 is described below

commit ee22a18ad829f296441bcc2d4091b2a26fb63309
Author: Andrew Stitcher <as...@apache.org>
AuthorDate: Wed Aug 28 17:20:40 2019 -0400

    PROTON-2086: Fix small errors in python sphinx doc build process
    - Actually need both sphinx and sphinx_automodapi for doc generation
    - There was an error in the cmake code if sphinx wasn't detected
      We don't need a specific message telling us the python version tried as it
      will always be the python version detected earlier by CMake.
---
 python/CMakeLists.txt | 11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)

diff --git a/python/CMakeLists.txt b/python/CMakeLists.txt
index ffac0e5..b5c1f3b 100644
--- a/python/CMakeLists.txt
+++ b/python/CMakeLists.txt
@@ -120,8 +120,10 @@ py_compile(${CMAKE_CURRENT_SOURCE_DIR} "${pysrc}" PROTON_ARTIFACTS)
 
 # Sphinx documentation
 check_python_module("sphinx" SPHINX_MODULE_FOUND)
-if (SPHINX_MODULE_FOUND)
-    message(STATUS "Python Sphinx module found - doc generation enabled.")
+check_python_module("sphinx_automodapi" SPHINX_AUTOMODAPI_MODULE_FOUND)
+if (NOT SPHINX_MODULE_FOUND OR NOT SPHINX_AUTOMODAPI_MODULE_FOUND)
+    message(STATUS "Sphinx modules not found; doc generation disabled.")
+else ()
     add_custom_target(docs-py
         COMMAND ${PN_ENV_SCRIPT} --
         PYTHONPATH=${CMAKE_CURRENT_BINARY_DIR}:${CMAKE_CURRENT_SOURCE_DIR}
@@ -132,11 +134,6 @@ if (SPHINX_MODULE_FOUND)
             DESTINATION "${PROTON_SHARE}/docs/api-py"
             COMPONENT documentation
             OPTIONAL)
-else ()
-    execute_process(COMMAND ${PYTHON_EXECUTABLE} --version
-                    ERROR_VARIABLE PYTHYON_VERSION_ERR)
-    string(STRIP ${PYTHYON_VERSION_ERR} PYTHON_VERSION_STR)
-    message(WARNING "Sphinx module NOT found for ${PYTHON_VERSION_STR} - doc generation disabled.")
 endif ()
 
 install(FILES ${CPROTON_ARTIFACTS}


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org