research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add TOC to the compiling docs

Browse source
This commit is contained in:
Bryan W. Weber 2016-12-28 19:23:53 -05:00 • committed by Ray Speth
parent 608f457614
commit 74a583a6d0
1 changed files with 19 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
doc/sphinx/compiling.rst
View file

@ -4,31 +4,11 @@
Cantera Compilation Guide
*************************
.. toctree::
:hidden:
This guide contains instructions for compiling Cantera on supported operating
systems and provides some detail of the possible configuration options.
SCons Configuration Options <configuring>
This guide contains instructions for compiling Cantera on the following
operating systems:
* :ref:`sec-linux`
* :ref:`sec-ubuntu-debian-reqs`
* :ref:`sec-fedora-reqs`
* :ref:`sec-opensuse-reqs`
* :ref:`sec-windows`
* :ref:`sec-windows-reqs`
* :ref:`sec-osx`
* :ref:`sec-mac-os-reqs`
In addition to the above operating systems, Cantera should work on any
Unix-like system where the necessary prerequisites are available, but some
additional configuration may be required.
.. contents::
:local:
.. _sec-installation-reqs:
@ -63,6 +43,10 @@ General Notes
* Users of other distributions should install the equivalent packages, which
may have slightly different names.
* In addition to the below operating systems, Cantera should work on any
Unix-like system where the necessary prerequisites are available, but some
additional configuration may be required.
.. _sec-ubuntu-debian-reqs:
Ubuntu & Debian
@ -346,10 +330,10 @@ Windows Requirements
where ``YY`` is a two digit year and ``n`` is either ``a`` or ``b``/Applications/MATLAB_R2011a.app
.. _sec-osx:
.. _sec-macos:
OS X
----
OS X & macOS
------------
General Notes
^^^^^^^^^^^^^
@ -562,6 +546,14 @@ Common Options
Windows Only Options
^^^^^^^^^^^^^^^^^^^^
.. note::
The ``cantera.conf`` file uses the backslash character ``\`` as an escape
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.
* 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.
@ -573,14 +565,6 @@ Windows Only Options
Studio compiler. If you aren't building the Python module, you can override
this with the configuration options ``target_arch`` and ``msvc_version``.
.. note::
The ``cantera.conf`` file uses the backslash character ``\`` as an escape
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.
* To compile with MinGW, specify the :ref:`toolchain <toolchain>` option::
toolchain=mingw