Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/source/atm/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Overview of Atmosphere Choices
fixed-tsurf
fixed-psurf
fixed-psurf-tsurf
mapping
structure

The ``atm_option`` control determines MESA's overall approach to
evaluating :math:`T_{\rm surf}` and :math:`P_{\rm surf}`, as follows:
Expand Down
3 changes: 0 additions & 3 deletions docs/source/auto_diff/example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
Example of ``auto_diff`` in ``run_star_extras``
===============================================

.. toctree::
:maxdepth: 1

The ``auto_diff`` module simplifies using ``run_star_extras`` hooks that
need to provide partial derivatives.
For example, the ``other_surface_PT`` hook can be used to specify an alternate
Expand Down
6 changes: 5 additions & 1 deletion docs/source/auto_diff/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@ Overview of ``auto_diff`` module
================================

.. toctree::
:maxdepth: 1
:maxdepth: 2
:hidden:

example
more_detail

The ``auto_diff`` module provides Fortran derived types that support automatic
differentiation via operator overloading. Users will not generally
Expand Down
7 changes: 7 additions & 0 deletions docs/source/colors/overview.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Overview of colors module
=========================


.. toctree::
:maxdepth: 2
:hidden:

defaults

The ``colors`` module calculates synthetic photometry during stellar evolution.
The module computes bolometric and synthetic magnitudes by interpolating stellar atmosphere model grids and convolving with photometric filter transmission curves.

Expand Down
7 changes: 7 additions & 0 deletions docs/source/eos/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
Overview of ``eos`` module
==========================

.. toctree::
:maxdepth: 1
:hidden:

defaults
interface

The equation of state (EOS) is delivered by the ``eos`` module. The
MESA EOS combines different input sources in order to cover the wide
range of conditions encountered during stellar evolution. The most
Expand Down
7 changes: 7 additions & 0 deletions docs/source/kap/overview.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Overview of kap module
======================

.. toctree::
:maxdepth: 1
:hidden:

defaults
interface

The opacity values returned by the ``kap`` module combine opacity
data from many sources. The most important opacity-related MESA
options select which opacity sources to use and control the location
Expand Down
11 changes: 0 additions & 11 deletions docs/source/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,6 @@ subsidiary controls.
.. toctree::

atm/overview
atm/mapping
atm/structure

.. _auto_diff:

Expand All @@ -61,8 +59,6 @@ automatic calculation of analytic derivatives using the chain rule.
.. toctree::

auto_diff/overview
auto_diff/example
auto_diff/more_detail


.. _chem:
Expand All @@ -86,7 +82,6 @@ The ``colors`` module calculates synthetic photometry during stellar evolution.
:maxdepth: 1

colors/overview
colors/defaults


.. _const:
Expand All @@ -110,9 +105,6 @@ The ``eos`` module provides the equation of state.
:maxdepth: 1

eos/overview
eos/defaults
eos/interface


.. _kap:

Expand All @@ -126,8 +118,6 @@ conductive opacities.
:maxdepth: 1

kap/overview
kap/defaults
kap/interface

.. _net:

Expand All @@ -140,7 +130,6 @@ The ``net`` module implements nuclear reaction networks.
:maxdepth: 1

net/overview
net/nets

.. _neu:

Expand Down
6 changes: 6 additions & 0 deletions docs/source/net/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
Overview of net module
======================

.. toctree::
:maxdepth: 2
:hidden:

nets

The ``net`` module implements nuclear reaction networks.


Expand Down
3 changes: 0 additions & 3 deletions docs/source/turb/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
Overview of turb module
=======================

.. toctree::
:maxdepth: 1

The ``turb`` module provides routines for computing properties of turbulence
under local theories, including ``mlt`` (mixing-length theory), ``tdc`` (time-dependent convection),
semiconvection, and thermohaline turbulence.
Expand Down