AnotherFoxGuy/polyvox
1
0
Fork 0
Code Issues Pull Requests Activity

Add information about building the manual to the INSTALL.txt

Browse Source
This commit is contained in:
Matt Williams 2010-07-14 12:44:08 +00:00
parent 5e62a35f42
commit 8a3417461d
3 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CMakeLists.txt
View File

@ -63,4 +63,5 @@ MESSAGE(STATUS "Build examples: " ${ENABLE_EXAMPLES})
MESSAGE(STATUS "Build tests: " ${BUILD_TESTING}) MESSAGE(STATUS "Build tests: " ${BUILD_TESTING})
MESSAGE(STATUS "API Docs available: " ${DOXYGEN_FOUND}) MESSAGE(STATUS "API Docs available: " ${DOXYGEN_FOUND})
MESSAGE(STATUS " - Qt Help bundling: " ${BUILD_AND_BUNDLE_DOCS}) MESSAGE(STATUS " - Qt Help bundling: " ${BUILD_AND_BUNDLE_DOCS})
MESSAGE(STATUS "Build manual: " ${BUILD_MANUAL})
MESSAGE(STATUS "") MESSAGE(STATUS "")

18
INSTALL.txt
View File

@ -10,11 +10,12 @@ To build PolyVox you need:
* `CMake <http://cmake.org>`_ 2.6 or greater * `CMake <http://cmake.org>`_ 2.6 or greater
* A C++ compiler with support for some C++0x features (GCC 4.3 or VC 2010 seem to work) * 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 <http://qt.nokia.com>`_ for building the tests * `Qt <http://qt.nokia.com>`_ for building the tests
* ``qcollectiongenerator`` which comes with Qt Assistant is used for bundling the docs for installation * ``qcollectiongenerator`` which comes with Qt Assistant is used for bundling the docs for installation
* `Doxygen <http://doxygen.org>`_ for building the documentation * `Doxygen <http://doxygen.org>`_ for building the documentation. Version 1.5.7 is needed to build the Qt Assistant docs. 1.7.0 or greater is recommended
* `Python <http://python.org>`_ and `Sphinx <http://sphinx.pocoo.org>`_ for generating the PolyVox manual in HTML
Linux 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. 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 <http://sphinx.pocoo.org>`_ 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 ``<build directory>/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 Windows
======= =======

4
documentation/CMakeLists.txt
View File

@ -9,4 +9,8 @@ if(SPHINXBUILD_EXECUTABLE AND QT_QCOLLECTIONGENERATOR_EXECUTABLE)
-c ${CMAKE_CURRENT_BINARY_DIR} #Load the conf.py from the binary dir -c ${CMAKE_CURRENT_BINARY_DIR} #Load the conf.py from the binary dir
${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_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() endif()