Skip to content

Commit

Permalink
Make section headings consistent (first-cap only) in ReadTheDocs
Browse files Browse the repository at this point in the history
This will make the table of contents look consistent, with only the
first character of each section & subsection heading capitalized
(excluding subsections that are commands etc.)

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
  • Loading branch information
yantosca committed May 18, 2022
1 parent 1b115c8 commit c2c790f
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 35 deletions.
2 changes: 1 addition & 1 deletion docs/source/getting_started/00_revision_history.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
####################
KPP Revision History
KPP revision history
####################

Only the major new features are listed here. For a detailed description
Expand Down
4 changes: 2 additions & 2 deletions docs/source/getting_started/02_running_kpp_sample_mech.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _running-kpp-with-an-example-mechanism:

###################################################
Running KPP with an Example Stratospheric Mechanism
Running KPP with an example stratospheric mechanism
###################################################

Here we consider as an example a very simple Chapman-like mechanism for
Expand Down Expand Up @@ -68,7 +68,7 @@ In the following sections we will refer to
.. _example-step-2:

===============================
2. Create a KPP definition file
2. Create a KPP Definition File
===============================

Create a KPP definition file in the example folder. The name
Expand Down
21 changes: 5 additions & 16 deletions docs/source/tech_info/06_info_for_kpp_developers.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _developer-info:

##############################
Information for KPP Developers
Information for KPP developers
##############################

This chapter is meant for KPP Developers. It describes the internal
Expand Down Expand Up @@ -194,7 +194,7 @@ KPP internal modules

.. _scanner-parser:

Scanner and Parser
Scanner and parser
------------------

This module is responsible for reading the kinetic description files and
Expand Down Expand Up @@ -317,7 +317,7 @@ an example:
.. _ci-tests:

============================
Continuous Integration Tests
Continuous integration tests
============================

In KPP 2.4.0 and later, we have added several continuous integration
Expand Down Expand Up @@ -402,19 +402,8 @@ List of continuous integration tests
+-----------------------+------------------------------------------------+

Each continuous integration test is contained in a subfolder of
:file:`$KPP_HOME/ci-tests` and contains the following files (or
symbolic links to files):

- A KPP definition file (ending in :file:`.kpp`) from
:file:`$KPP_HOME/models/`;

- Mechanism definition files (ending in :file:`.def`,
:file:`.eqn`, and :file:`.spc`) from :file:`$KPP_HOME/examples`;

- A KPP integrator and integrator definition file (ending in
:file:`.def`) from :file:`$KPP_HOME/int/`

- A driver program from :file:`$KPP_HOME/drv`;
:file:`$KPP_HOME/ci-tests` a KPP definition file (ending in
:file:`.kpp`) from :file:`$KPP_HOME/models/`.

.. _running-ci-tests-on-azure:

Expand Down
14 changes: 7 additions & 7 deletions docs/source/tech_info/07_numerical_methods.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ in KPP. The symbols used in the formulas are explained in
.. _rosenbrock-methods:

==================
Rosenbrock Methods
Rosenbrock methods
==================

An :math:`s`-stage Rosenbrock method (cf. Section IV.7 in
Expand Down Expand Up @@ -258,7 +258,7 @@ RODAS-4
.. _rosenbrock-tlm:

Rosenbrock Tangent Linear Model
Rosenbrock tangent linear model
--------------------------------

The Tangent Linear method is combined with the sensitivity
Expand Down Expand Up @@ -299,7 +299,7 @@ respect to parameters for efficiency.

.. _rosenbrock-adjoint:

Rosenbrock Discrete Adjoint Model
Rosenbrock discrete adjoint model
---------------------------------

To obtain the adjoint we first differentiate the method with respect to
Expand Down Expand Up @@ -411,8 +411,8 @@ implementation of :cite:`1991:Hairer_and_Wanner`.

.. _rk-tlm:

RK Tangent Linear Model
------------------------
RK tangent linear model
-----------------------

The tangent linear method associated with the Runge-Kutta method is

Expand All @@ -435,7 +435,7 @@ factorization of a different matrix.

.. _rk-adj:

RK Discrete Adjoint Model
RK discrete adjoint model
-------------------------

The first order Runge-Kutta adjoint is
Expand Down Expand Up @@ -463,7 +463,7 @@ another Runge-Kutta method:
.. _back-diff:

=================================
Backward Differentiation Formulas
Backward differentiation formulas
=================================

Backward differentiation formulas (BDF) are linear multistep methods
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tech_info/08_bnf_description_of_kpp_lang.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _bnf-description:

###################################
BNF Description of the KPP Language
BNF description of the KPP language
###################################

Following is the BNF-like specification of the KPP language:
Expand Down
10 changes: 5 additions & 5 deletions docs/source/using_kpp/04_input_for_kpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ finally the equations of the chemical mechanism.
.. _kpp-sections:

============
KPP Sections
KPP sections
============

A :literal:`#` sign at the beginning of a line followed by a section
Expand Down Expand Up @@ -365,7 +365,7 @@ included in the transport calculations.
.. _kpp-commands:

============
KPP Commands
KPP commands
============

A command begins on a new line with a :code:`#` sign, followed by a
Expand Down Expand Up @@ -858,7 +858,7 @@ This inline type can be used to define utility subroutines.
.. _auxiliary-files-and-the-substitution-preprocessor:

=================================================
Auxiliary Files and the Substitution Preprocessor
Auxiliary files and the substitution preprocessor
=================================================

The `auxiliary files <auxiliary-files-for-fortran-90_>`_ are
Expand Down Expand Up @@ -914,7 +914,7 @@ in the generated Fortran90 output file.

.. _auxiliary-files-for-fortran-90:

List of Auxiliary Files for Fortran90
List of auxiliary files for Fortran90
--------------------------------------

KPP inline codes or other instructions contained in the following
Expand Down Expand Up @@ -956,7 +956,7 @@ files, as shown in :ref:`table-aux-files`.

.. _list-of-symbols-replaced:

List of Symbols Replaced by the Substitution Preprocessor
List of symbols replaced by the substitution preprocessor
----------------------------------------------------------

The following symbols in KPP-generated source code will be replaced
Expand Down
6 changes: 3 additions & 3 deletions docs/source/using_kpp/05_output_from_kpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ KPP.
.. _f90-code:

==================
The Fortran90 Code
The Fortran90 code
==================

The code generated by KPP is organized in a set of separate files. Each
Expand Down Expand Up @@ -925,7 +925,7 @@ main program file manually to the Makefile.
.. _C-code:

==========
The C Code
The C code
==========

The driver file :file:`ROOT.c` contains the main (driver) and
Expand Down Expand Up @@ -981,7 +981,7 @@ function, Jacobian, and Hessian to be called directly from Matlab
.. _matlab-code:

===============
The Matlab Code
The Matlab code
===============

`Matlab <http://www.mathworks.com/products/matlab/>`_ provides a high-level
Expand Down

0 comments on commit c2c790f

Please sign in to comment.