[Docs] Fix small typos in Compiling docs

This commit is contained in:
Bryan W. Weber 2017-01-02 20:39:56 -05:00 committed by Ray Speth
parent cf5e45d697
commit d84f482400

View file

@ -168,6 +168,7 @@ the full list of dependencies.
Python used for the compilation. To generate different modules for other
versions of Python, you will need to install those versions of Python and
recompile.
* If you want to build the Matlab toolbox and you have a 64-bit copy of
Windows, by default you will be using a 64-bit copy of Matlab, and therefore
you need to compile Cantera in 64-bit mode. For simplicity, it is highly
@ -176,9 +177,10 @@ the full list of dependencies.
* It is generally helpful to have SCons and Python in your PATH. This can
usually be accomplished by adding the top-level Python directory
(e.g. ``C:\Python27``) to your PATH. This is accessible from::
(e.g. ``C:\Python27;C:\Python27\Scripts``) to your PATH. This is accessible from::
Control Panel > System and Security > System > Advanced System Settings > Environment Variables
* In order to use SCons to install Cantera to a system folder (e.g. ``C:\Program
Files\Cantera``) you must run the ``scons install`` command in a command
prompt that has been launched by selecting the *run as administrator* option.
@ -297,6 +299,7 @@ General
* If the prerequisites are installed in standard locations, the default values
should work.
* If you installed Sundials to a non-standard location (e.g. the libraries
aren't in /usr/lib), you will need to specify the options::
@ -312,20 +315,20 @@ General
The above paths are typical defaults on Linux, Windows, and OS X,
respectively.
* SCons saves configuration options specified on the command line in the file
**cantera.conf** in the root directory of the source tree, so generally it is
``cantera.conf`` in the root directory of the source tree, so generally it is
not necessary to respecify configuration options when rebuilding Cantera. To
unset a previously set configuration option, either remove the corresponding
line from cantera.conf or use the syntax::
line from ``cantera.conf`` or use the syntax::
option_name=
scons command option_name=
* Sometimes, changes in your environment can cause SCons's configuration tests
(e.g. checking for libraries or compiler capabilities) to unexpectedly fail.
To force SCons to re-run these tests rather than trusting the cached results,
run scons with the option ``--config=force``.
Python Module
-------------
@ -336,13 +339,13 @@ The Python module is compatible with the following Python versions: 2.7
and 3.2 - 3.5.
Building for Python 2
.....................
^^^^^^^^^^^^^^^^^^^^^
By default, SCons will attempt to build the Cython-based Python module for
Python 2, if both Numpy and Cython are installed.
Building for Python 3
.....................
^^^^^^^^^^^^^^^^^^^^^
If SCons detects a Python 3 interpreter installed in a default location
(i.e. ``python3`` is on the path), it will try to build the Python module
@ -362,8 +365,10 @@ Windows (MSVC)
* In Windows there aren't any proper default locations for many of the packages
that Cantera depends on, so you will need to specify these paths explicitly.
* Remember to put double quotes around any paths with spaces in them, e.g.
"C:\Program Files".
``"C:\Program Files"``.
* By default, SCons attempts to use the same architecture as the copy of Python
that is running SCons, and the most recent installed version of the Visual
Studio compiler. If you aren't building the Python module, you can override
@ -375,8 +380,7 @@ Windows (MSVC)
character. When modifying this file, backslashes in paths need to be escaped
like this: ``boost_inc_dir = 'C:\\Program Files (x86)\\boost\\include'``
This does not apply to paths specified on the command line. Alternatively,
you can use forward slashes in paths.
you can use forward slashes (``/``) in paths.
Windows (MinGW)
---------------
@ -432,7 +436,7 @@ Intel Compilers
Compile Cantera & Test
======================
* Run scons with the list of desired configuration options, e.g.::
* Run SCons with the list of desired configuration options, e.g.::
scons build optimize=n blas_lapack_libs=blas,lapack prefix=/opt/cantera
@ -447,6 +451,7 @@ Compile Cantera & Test
* If you do not see this message, check the output for errors to see what went
wrong.
* Cantera has a series of tests that can be run with the command::
scons test
@ -457,7 +462,7 @@ Compile Cantera & Test
* If you have tests that fail, try looking at the following to determine the
source of the error:
* Messages printed to the console while running scons test
* Messages printed to the console while running ``scons test``
* Output files generated by the tests
Building Documentation
@ -468,7 +473,7 @@ Building Documentation
scons doxygen
scons sphinx
or append the options `sphinx_docs=y` and `doxygen_docs=y` to the build
or append the options ``sphinx_docs=y`` and ``doxygen_docs=y`` to the build
command, e.g.::
scons build doxygen_docs=y sphinx_docs=y