Update old information about building

Author: robertodr

doc/users/building.rst

@@ -28,40 +28,39 @@ the unit test suite.
 Libraries and toolchain programs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-+ CMake version 2.8.9 and higher;
++ CMake version 2.8.10 and higher;
 + Git version 1.7.1 and higher;
-+ Python interpreter 2.4 and higher;
++ Python interpreter 2.7 and higher;
 + Boost libraries version 1.54.0 and higher;
 
 .. note::
 
-   Version 1.54.0 of Boost libraries is shipped with the module and resides in the `cmake/downloaded` subdirectory.
+   Version 1.54.0 of Boost libraries is shipped with the module and resides in the ``cmake/downloaded`` subdirectory.
    Unless you want to use another version of Boost, you should not worry about satisfying this dependency.
 
 + `zlib <http://www.zlib.net/>`_ version 1.2 and higher (unit test suite only);
 + Doxygen version 1.7.6 and higher (documentation only)
 + Perl (documentation only)
-+ PyYAML Python module (documentation only)
 + Sphinx (documentation only)
 
 PCMSolver relies on the Eigen template libraries version 3.3.0 and higher.
-Version 3.3.0 of Eigen libraries is shipped with the module and resides in the `external` subdirectory.
+Version 3.3.0 of Eigen libraries is shipped with the module and resides in the ``external`` subdirectory.
 
 Configuration
 -------------
 
-Configuration is managed through the front-end script `setup` residing in the
+Configuration is managed through the front-end script ``setup`` residing in the
 repository main directory. Issuing:
 
 .. code-block:: bash
 
    ./setup [options] [build path]
 
 will create the build directory in build path and run CMake with the given
-options. By default, files are configured in the `build` directory. The `-h` or
-`--help` option will list the available options and their effect. Options can
-be forwarded directly to CMake by using the `--cmake-options` flag and listing
-the `-D...` options. Usually the following command is sufficient to get the
+options. By default, files are configured in the ``build`` directory. The ``-h`` or
+``--help`` option will list the available options and their effect. Options can
+be forwarded directly to CMake by using the ``--cmake-options`` flag and listing
+the ``-D...`` options. Usually the following command is sufficient to get the
 configuration done for a debug build, including compilation of the unit test
 suite:
 
@@ -70,7 +69,7 @@ suite:
    ./setup --type=debug
 
 The unit tests suite is **always** compiled in standalone mode, unless the
-`-DENABLE_TESTS=OFF` option is forwarded to CMake.
+``-DENABLE_TESTS=OFF`` option is forwarded to CMake.
 
 Getting Boost
 ~~~~~~~~~~~~~
@@ -87,22 +86,22 @@ documentation on how to build Boost on Unix variants is available
 `here <http://www.boost.org/doc/libs/1_56_0/more/getting_started/unix-variants.html>`_.
 It is here assumed that the user **does not** have root access to the machine
 and will install the libraries to a local prefix, a subdirectory of
-`/home/user-name` tipically.
+``/home/user-name`` tipically.
 Once you've downloaded and unpacked the archive, run the bootstrap script to configure:
 
 .. code-block:: bash
 
    cd path/to/boost
    ./bootstrap.sh --prefix=/home/user-name/boost
 
-Running `./bootstrap.sh --help` will list the available options for the script. To build run:
+Running ``./bootstrap.sh --help`` will list the available options for the script. To build run:
 
 .. code-block:: bash
 
    ./b2 install
 
 This might take a while. After a successful build you will find the headers in
-`/home/user-name/boost/include` and libraries in `/home/user-name/boost/lib`
+``/home/user-name/boost/include`` and libraries in ``/home/user-name/boost/lib``
 Now, you will have Boost in a nonstandard location. Without hints CMake will
 not be able to find it and configuration of `PCMSolver` will fail.  To avoid
 this, you will have to pass the location of the headers and libraries to the
@@ -124,55 +123,55 @@ Advanced configuration options
 These options are marked as advanced as it is highly unlikely they will
 be useful when not programming the library:
 
-* `--exdiag` Enable C++ extended diagnostics flags. Disabled by default.
-* `--ccache` Enable use of ccache for C/C++ compilation caching.
+* ``--exdiag`` Enable C++ extended diagnostics flags. Disabled by default.
+* ``--ccache`` Enable use of ccache for C/C++ compilation caching.
   Enabled by default, unless ccache is not available.
-* `--build-boost` Deactivate Boost detection and build on-the-fly. Disabled by default.
-* `--eigen` Root directory for Eigen3. Search for Eigen3 in the location provided by the
+* ``--build-boost`` Deactivate Boost detection and build on-the-fly. Disabled by default.
+* ``--eigen`` Root directory for Eigen3. Search for Eigen3 in the location provided by the
   user. If search fails, fall back to the version bundled with the library.
-* `--static` Create only static library. Disabled by default.
+* ``--static`` Create only static library. Disabled by default.
 
-Some options can only be tweaked `via` `--cmake-options` to the setup script:
+Some options can only be tweaked `via` ``--cmake-options`` to the setup script:
 
-* `ENABLE_CXX11_SUPPORT` Enable C++11 support. Tries to detect which C++11 features
+* ``ENABLE_CXX11_SUPPORT`` Enable C++11 support. Tries to detect which C++11 features
   are supported by the compiler and enables use of the new standard. Enabled by default.
 
   .. warning::
 
      This option is **always** overridden for some compilers that have
      buggy C++11 support.
 
-* `ENABLE_DOCS` Enable build of documentation. This requires a number of additional dependencies.
+* ``ENABLE_DOCS`` Enable build of documentation. This requires a number of additional dependencies.
   If any of these are not met, documentation is not built. Enabled by default.
-* `ENABLE_LOGGER` Enable compilation of logger sources. Disabled by default.
+* ``ENABLE_LOGGER`` Enable compilation of logger sources. Disabled by default.
 
   .. warning::
 
      The logger is not currently in use in any part of the code.
 
-* `ENABLE_TIMER` Enable compilation of timer sources. Enabled by default.
-* `BUILD_STANDALONE` Enable compilation of standalone `run_pcm` executable. Enabled by default.
-* `ENABLE_Fortran_API` Enable compilation of the Fortran90 bindings for the API. Enabled by default.
-* `ENABLE_GENERIC` Enable mostly static linking in shared library. Disabled by default.
-* `ENABLE_TESTS` Enable compilation of unit tests suite. Enabled by default.
-* `SHARED_LIBRARY_ONLY` Create only shared library. Opposite of `--static`.
-* `PYMOD_INSTALL_LIBDIR` *If set*, installs python scripts/modules to
+* ``ENABLE_TIMER`` Enable compilation of timer sources. Enabled by default.
+* ``BUILD_STANDALONE`` Enable compilation of standalone ``run_pcm`` executable. Enabled by default.
+* ``ENABLE_Fortran_API`` Enable compilation of the Fortran90 bindings for the API. Enabled by default.
+* ``ENABLE_GENERIC`` Enable mostly static linking in shared library. Disabled by default.
+* ``ENABLE_TESTS`` Enable compilation of unit tests suite. Enabled by default.
+* ``SHARED_LIBRARY_ONLY`` Create only shared library. Opposite of ``--static``.
+* ``PYMOD_INSTALL_LIBDIR`` *If set*, installs python scripts/modules to
   ``${CMAKE_INSTALL_LIBDIR}${PYMOD_INSTALL_LIBDIR}/pcmsolver`` rather than the
   default ``${CMAKE_INSTALL_BINDIR}`` (i.e., ``bin``).
-* `CMAKE_INSTALL_BINDIR` Where to install executables, if not to ``bin``.
-* `CMAKE_INSTALL_LIBDIR` Where to install executables, if not to ``bin``.
-* `CMAKE_INSTALL_INCLUDESDIR` Where to install executables, if not to ``bin``.
-
-* `CMAKE_INSTALL_BINDIR` Location within CMAKE_INSTALL_PREFIX (``--prefix``) to
-  which executables are installed (default: bin).
-* `CMAKE_INSTALL_LIBDIR` Location within CMAKE_INSTALL_PREFIX (``--prefix``) to
-  which libraries are installed (default: lib).
-* `CMAKE_INSTALL_INCLUDEDIR` Location within CMAKE_INSTALL_PREFIX (``--prefix``)
-  to which headers are installed (default: include).
-* `PYMOD_INSTALL_LIBDIR` *If set*, location within CMAKE_INSTALL_LIBDIR to which
+* ``CMAKE_INSTALL_BINDIR`` Where to install executables, if not to ``bin``.
+* ``CMAKE_INSTALL_LIBDIR`` Where to install executables, if not to ``bin``.
+* ``CMAKE_INSTALL_INCLUDESDIR`` Where to install executables, if not to ``bin``.
+
+* ``CMAKE_INSTALL_BINDIR`` Location within ``CMAKE_INSTALL_PREFIX`` (``--prefix``) to
+  which executables are installed (default: ``bin``).
+* ``CMAKE_INSTALL_LIBDIR`` Location within ``CMAKE_INSTALL_PREFIX`` (``--prefix``) to
+  which libraries are installed (default: ``lib``).
+* ``CMAKE_INSTALL_INCLUDEDIR`` Location within ``CMAKE_INSTALL_PREFIX`` (``--prefix```)
+  to which headers are installed (default: ``include``).
+* ``PYMOD_INSTALL_LIBDIR`` *If set*, location within ``CMAKE_INSTALL_LIBDIR`` to which
   python modules are installed,
-  ``${CMAKE_INSTALL_LIBDIR}${PYMOD_INSTALL_LIBDIR}/pcmsolver``. *If not set*,
-  python modules installed to default ``${CMAKE_INSTALL_BINDIR}`` (i.e., ``bin``).
+  ``${CMAKE_INSTALL_LIBDIR}/${PYMOD_INSTALL_LIBDIR}/pcmsolver``. *If not set*,
+  python modules installed to default ``${CMAKE_INSTALL_LIBDIR}/python/pcmsolver``.
 
 Build and test
 --------------
@@ -183,13 +182,13 @@ To compile and link, just go to the build directory and run:
 
    make -j N
 
-where `N` is the number of cores you want to use when building.
+where ``N`` is the number of cores you want to use when building.
 
 .. note::
 
    Building on more than one core can sometimes result in a "race condition"
    and a crash. If that happens, please report the problem as an issue on our
-   issue tracker on GitHub. Running `make` on a single core might get you through
+   issue tracker on GitHub. Running ``make`` on a single core might get you through
    compilation.
 
 To run the whole test suite: