diff --git a/CMakeLists.txt b/CMakeLists.txt index 8d905613..3d50b527 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -63,4 +63,5 @@ MESSAGE(STATUS "Build examples: " ${ENABLE_EXAMPLES}) MESSAGE(STATUS "Build tests: " ${BUILD_TESTING}) MESSAGE(STATUS "API Docs available: " ${DOXYGEN_FOUND}) MESSAGE(STATUS " - Qt Help bundling: " ${BUILD_AND_BUNDLE_DOCS}) +MESSAGE(STATUS "Build manual: " ${BUILD_MANUAL}) MESSAGE(STATUS "") diff --git a/INSTALL.txt b/INSTALL.txt index 90511a77..cb04db33 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -10,11 +10,12 @@ To build PolyVox you need: * `CMake `_ 2.6 or greater * A C++ compiler with support for some C++0x features (GCC 4.3 or VC 2010 seem to work) -With the following options: +With the following optional packages: * `Qt `_ for building the tests * ``qcollectiongenerator`` which comes with Qt Assistant is used for bundling the docs for installation -* `Doxygen `_ for building the documentation +* `Doxygen `_ for building the documentation. Version 1.5.7 is needed to build the Qt Assistant docs. 1.7.0 or greater is recommended +* `Python `_ and `Sphinx `_ for generating the PolyVox manual in HTML Linux ===== @@ -90,6 +91,19 @@ On top of this, if ``qcollectiongenerator`` is installed, PolyVox can also compi This allows indexed searching of the documentation and easier browsing. +Manual +------ + +As well as the API documentation, PolyVox also provides a user manual. This is written using `Sphinx `_ and so to convert the documentation sources to HTML requires Sphinx and Python to be installed. If these are installed and found then you will see ``Build manual: YES`` in the CMake summary output. If this is the case then just run:: + + make manual + +and the HTML manual will be available at ``/documentation/index.html``. + +If you have Sphinx installed but you do not get the confirmation in the CMake output, you may need to set ``SPHINXBUILD_EXECUTABLE`` to the location of you ``sphinx-build`` executable. + +If you do not have Python and Sphinx installed and do not want to install them then the manual is just plain text (``.rst`` files) which are readable in their plain form. + Windows ======= diff --git a/documentation/CMakeLists.txt b/documentation/CMakeLists.txt index 7f2d2c7f..4321cb68 100644 --- a/documentation/CMakeLists.txt +++ b/documentation/CMakeLists.txt @@ -9,4 +9,8 @@ if(SPHINXBUILD_EXECUTABLE AND QT_QCOLLECTIONGENERATOR_EXECUTABLE) -c ${CMAKE_CURRENT_BINARY_DIR} #Load the conf.py from the binary dir ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR} ) + set(BUILD_MANUAL YES PARENT_SCOPE) +else()" + message(STATUS "`sphinx-build` was not found. Try setting SPHINXBUILD_EXECUTABLE to its location.") + set(BUILD_MANUAL NO PARENT_SCOPE) endif()