[Doc] Update compilation documentation
This commit is contained in:
parent
a609631981
commit
6898976218
1 changed files with 24 additions and 0 deletions
|
|
@ -161,6 +161,11 @@ General
|
|||
|
||||
* run ``scons help`` to see a list all configuration options for Cantera, or
|
||||
see :ref:`scons-config`.
|
||||
* Configuration options are specified as additional arguments to the ``scons``
|
||||
command, e.g.::
|
||||
|
||||
scons build -j4 blas_lapack_libs=lapack,blas
|
||||
|
||||
* 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
|
||||
|
|
@ -186,6 +191,12 @@ General
|
|||
|
||||
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
|
||||
-------------
|
||||
|
||||
|
|
@ -327,6 +338,19 @@ Compile Cantera & Test
|
|||
* Messages printed to the console while running scons test
|
||||
* Output files generated by the tests
|
||||
|
||||
Building Documentation
|
||||
----------------------
|
||||
|
||||
* To build the Cantera HTML documentation, run the commands::
|
||||
|
||||
scons doxygen
|
||||
scons sphinx
|
||||
|
||||
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
|
||||
|
||||
MinGW Compilation problems
|
||||
--------------------------
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue