Skip to content

Commit

Permalink
use carets for headings instead of dots
Browse files Browse the repository at this point in the history
  • Loading branch information
mcflugen committed Nov 21, 2024
1 parent bafe7f2 commit d76cc08
Show file tree
Hide file tree
Showing 7 changed files with 48 additions and 48 deletions.
8 changes: 4 additions & 4 deletions docs/source/bmi.control_funcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ updating.
.. _initialize:

*initialize*
............
^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -46,7 +46,7 @@ formatted.
.. _update:

*update*
........
^^^^^^^^

.. code-block:: java
Expand All @@ -73,7 +73,7 @@ function can just return without doing anything.
.. _update_until:

*update_until*
..............
^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -99,7 +99,7 @@ to reflect that the model was updated to the requested time.
.. _finalize:

*finalize*
..........
^^^^^^^^^^

.. code-block:: java
Expand Down
10 changes: 5 additions & 5 deletions docs/source/bmi.getter_setter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ state variable can be changed or check the new data for validity.
.. _get_value:

*get_value*
...........
^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -52,7 +52,7 @@ even if the model uses dimensional variables.
.. _get_value_ptr:

*get_value_ptr*
...............
^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -79,7 +79,7 @@ even if the model's state has changed.
.. _get_value_at_indices:

*get_value_at_indices*
......................
^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -103,7 +103,7 @@ Additionally,
.. _set_value:

*set_value*
...........
^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -136,7 +136,7 @@ even if the model uses dimensional variables.
.. _set_value_at_indices:

*set_value_at_indices*
......................
^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down
32 changes: 16 additions & 16 deletions docs/source/bmi.grid_funcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ However, all BMI grid functions must be implemented.
.. _get_grid_type:

*get_grid_type*
...............
^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -58,7 +58,7 @@ is given in the :ref:`model_grids` section.
.. _get_grid_rank:

*get_grid_rank*
...............
^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -86,7 +86,7 @@ of :ref:`get_grid_x`, :ref:`get_grid_y`, etc. are implemented.
.. _get_grid_size:

*get_grid_size*
...............
^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -114,7 +114,7 @@ for :ref:`unstructured <unstructured_grids>` and
.. _get_grid_shape:

*get_grid_shape*
................
^^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -152,7 +152,7 @@ the cells.
.. _get_grid_spacing:

*get_grid_spacing*
..................
^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -181,7 +181,7 @@ the spacing between rows is followed by spacing between columns, ``[dy, dx]``.
.. _get_grid_origin:

*get_grid_origin*
.................
^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -211,7 +211,7 @@ the origin is given in the column dimension, followed by the row dimension,
.. _get_grid_x:

*get_grid_x*
............
^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -239,7 +239,7 @@ See :ref:`model_grids` for more information.
.. _get_grid_y:

*get_grid_y*
............
^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -267,7 +267,7 @@ See :ref:`model_grids` for more information.
.. _get_grid_z:

*get_grid_z*
............
^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -295,7 +295,7 @@ See :ref:`model_grids` for more information.
.. _get_grid_node_count:

*get_grid_node_count*
.....................
^^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -317,7 +317,7 @@ Get the number of :term:`nodes <node>` in the grid.
.. _get_grid_edge_count:

*get_grid_edge_count*
.....................
^^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -339,7 +339,7 @@ Get the number of :term:`edges <edge>` in the grid.
.. _get_grid_face_count:

*get_grid_face_count*
.....................
^^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -361,7 +361,7 @@ Get the number of :term:`faces <face>` in the grid.
.. _get_grid_edge_nodes:

*get_grid_edge_nodes*
.....................
^^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -387,7 +387,7 @@ node at edge head. The total length of the array is
.. _get_grid_face_edges:

*get_grid_face_edges*
.....................
^^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -412,7 +412,7 @@ The length of the array returned is the sum of the values of
.. _get_grid_face_nodes:

*get_grid_face_nodes*
.....................
`````````````````````

.. code-block:: java
Expand Down Expand Up @@ -442,7 +442,7 @@ the length of the array is the sum of the values of
.. _get_grid_nodes_per_face:

*get_grid_nodes_per_face*
.........................
^^^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down
10 changes: 5 additions & 5 deletions docs/source/bmi.info_funcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ and provide to other models that have a BMI.
.. _get_component_name:

*get_component_name*
....................
^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -33,7 +33,7 @@ but it should be unique to prevent conflicts with other components.
.. _get_input_item_count:

*get_input_item_count*
......................
^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -55,7 +55,7 @@ Also the number of variables that can be set with :ref:`set_value`.
.. _get_output_item_count:

*get_output_item_count*
.......................
^^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -77,7 +77,7 @@ Also the number of variables that can be retrieved with :ref:`get_value`.
.. _get_input_var_names:

*get_input_var_names*
.....................
^^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -111,7 +111,7 @@ Standard Names do not have to be used within the model.
.. _get_output_var_names:

*get_output_var_names*
......................
^^^^^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down
10 changes: 5 additions & 5 deletions docs/source/bmi.time_funcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Model time is always expressed as a floating point value.
.. _get_current_time:

*get_current_time*
..................
^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -29,7 +29,7 @@ The current model time.
.. _get_start_time:

*get_start_time*
................
^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -50,7 +50,7 @@ The start time of the model.
.. _get_end_time:

*get_end_time*
................
^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -73,7 +73,7 @@ The end time of the model.
.. _get_time_units:

*get_time_units*
................
^^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -102,7 +102,7 @@ It's recommended to use `time unit conventions`_ from Unidata's
.. _get_time_step:

*get_time_step*
...............
^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down
12 changes: 6 additions & 6 deletions docs/source/bmi.var_funcs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ type or unit conversions can be applied when necessary.
.. _get_var_grid:

*get_var_grid*
..............
^^^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -43,7 +43,7 @@ A model can have one or more grids.
.. _get_var_type:

*get_var_type*
..............
^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -70,7 +70,7 @@ while in Fortran, use `integer`, `real`, and `double precision`.
.. _get_var_units:

*get_var_units*
...............
^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down Expand Up @@ -103,7 +103,7 @@ full description of valid unit names and a list of supported units.
.. _get_var_itemsize:

*get_var_itemsize*
..................
^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -126,7 +126,7 @@ For example, if data for a variable are stored as 64-bit integers,
.. _get_var_nbytes:

*get_var_nbytes*
................
^^^^^^^^^^^^^^^^

.. code-block:: java
Expand All @@ -147,7 +147,7 @@ a variable; i.e., the number of items multiplied by the size of each item.
.. _get_var_location:

*get_var_location*
..................
^^^^^^^^^^^^^^^^^^

.. code-block:: java
Expand Down
Loading

0 comments on commit d76cc08

Please sign in to comment.