master: fix white space below Syntax headings; see difference in 2024…

….xrst.

appendix/deprecated/compare_change.xrst

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 # SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-# SPDX-FileContributor: 2003-23 Bradley M. Bell
+# SPDX-FileContributor: 2003-24 Bradley M. Bell
 # ----------------------------------------------------------------------------
 {xrst_begin CompareChange app}
 
@@ -9,9 +9,10 @@ Comparison Changes During Zero Order Forward Mode
 
 Syntax
 ******
-*c* = *f* . ``CompareChange`` ()
+| *c* = *f* . ``CompareChange`` ()
 
-**See Also**
+See Also
+********
 :ref:`FunCheck-name`
 
 Deprecated 2015-01-20

appendix/deprecated/fun_deprecated.xrst

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 # SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-# SPDX-FileContributor: 2003-23 Bradley M. Bell
+# SPDX-FileContributor: 2003-24 Bradley M. Bell
 # ----------------------------------------------------------------------------
 {xrst_begin fun_deprecated app}
 
@@ -9,7 +9,6 @@ ADFun Object Deprecated Member Functions
 
 Syntax
 ******
-
 | *f* . ``Dependent`` ( *y* )
 | *o* = *f* . ``Order`` ()
 | *m* = *f* . ``Memory`` ()

appendix/deprecated/omp_alloc.xrst

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 # SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-# SPDX-FileContributor: 2003-22 Bradley M. Bell
+# SPDX-FileContributor: 2003-24 Bradley M. Bell
 # ----------------------------------------------------------------------------
 {xrst_begin omp_alloc app}
 
@@ -9,7 +9,7 @@ A Quick OpenMP Memory Allocator Used by CppAD
 
 Syntax
 ******
-``# include <cppad/omp_alloc.hpp>``
+| ``# include <cppad/omp_alloc.hpp>``
 
 Purpose
 *******

appendix/whats_new/2024.xrst

@@ -5,6 +5,7 @@
 
 {xrst_begin 2024 app}
 {xrst_spell
+   au
    bitwise
    boostvector
    bostvector
@@ -33,9 +34,28 @@ Release Notes for 2024
 mm-dd
 *****
 
+11-12
+=====
+Remove extra unintended white space below Syntax headings
+that was introduced when the CppAD documentation was converted from
+omhelp to sphinx; see :ref:`2022-12-16<2022@mm-dd@12-16>` .
+For example:
+
+Old Syntax
+----------
+
+   ``atomic_user`` *a_square_root*
+
+*a_square_root* ( *au* , *ay* )
+
+New Syntax
+----------
+| ``atomic_user`` *a_square_root*
+| *a_square_root* ( *au* , *ay* )
+
 10-04
 =====
-The :ref:`jit_compile.cpp-name` example line was missing 
+The :ref:`jit_compile.cpp-name` example line was missing
 CPPAD_C_COMPILER_CMD in the line (this has been fixed)::
 
    const char* cmd = CPPAD_C_COMPILER_CMD " --version > temp";
@@ -45,7 +65,7 @@ CPPAD_C_COMPILER_CMD in the line (this has been fixed)::
 #. The *include_eigen* argument was removed from the :ref:`cmake-name` command
    because Eigen is available using most package managers;
    see :ref:`cmake@Eigen` .
-#. Remove *boost_dir* and *eigen_dir* from :ref:`configure-name` 
+#. Remove *boost_dir* and *eigen_dir* from :ref:`configure-name`
    (they no longer have any effect).
 
 09-28

cppad_ipopt/src/cppad_ipopt_nlp.hpp

@@ -25,7 +25,6 @@ This interface to Ipopt is deprecated, use :ref:`ipopt_solve-name` instead.
 
 Syntax
 ******
-
 | # ``include`` ``"cppad_ipopt_nlp.hpp"``
 | ``cppad_ipopt_solution`` *solution* ;
 | ``cppad_ipopt_nlp`` *cppad_nlp* (

cppad_lib/code_gen_fun.cpp

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 /*
 {xrst_begin code_gen_fun}
@@ -14,8 +14,7 @@ Generate Source Code and Compile an AD Function
 
 Syntax
 ******
-
-   # ``include <cppad/example/code_gen_fun.hpp>``
+| # ``include <cppad/example/code_gen_fun.hpp>``
 
 Constructors
 ============

cppad_lib/csrc_writer.cpp

@@ -10,8 +10,7 @@ Converts Cpp Graph to C Source
 
 Syntax
 ******
-``csrc_writer(%os%, %graph_obj%, %c_type%)``
-``%``
+| ``csrc_writer`` ( *os* , *graph_obj* , *c_type* )
 
 Prototype
 *********

cppad_lib/temp_file.cpp

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 /*
 {xrst_begin temp_file dev}
@@ -13,8 +13,7 @@ Create a New Empty Temporary File
 
 Syntax
 ******
-
-   *file_name* = ``temp_file`` ()
+| *file_name* = ``temp_file`` ()
 
 file_name
 *********

example/abs_normal/abs_eval.hpp

@@ -2,7 +2,7 @@
 # define CPPAD_EXAMPLE_ABS_NORMAL_ABS_EVAL_HPP
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 /*
 {xrst_begin abs_eval}
@@ -11,7 +11,7 @@ abs_normal: Evaluate First Order Approximation
 
 Syntax
 ******
-*g_tilde* = ``abs_eval`` ( *n* , *m* , *s* , *g_hat* , *g_jac* , *delta_x* )
+| *g_tilde* = ``abs_eval`` ( *n* , *m* , *s* , *g_hat* , *g_jac* , *delta_x* )
 
 Prototype
 *********

example/abs_normal/abs_min_linear.hpp

@@ -2,7 +2,7 @@
 # define CPPAD_EXAMPLE_ABS_NORMAL_ABS_MIN_LINEAR_HPP
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 /*
 {xrst_begin abs_min_linear}
@@ -16,7 +16,6 @@ abs_normal: Minimize a Linear Abs-normal Approximation
 
 Syntax
 ******
-
 | *ok* = ``abs_min_linear`` (
 | |tab| *level* , *n* , *m* , *s* ,
 | |tab| *g_hat* , *g_jac* , *bound* , *epsilon* , *maxitr* , *delta_x*

example/abs_normal/abs_min_quad.hpp

@@ -16,7 +16,6 @@ abs_normal: Minimize a Linear Abs-normal Approximation
 
 Syntax
 ******
-
 | *ok* = ``abs_min_quad`` (
 | |tab| *level* , *n* , *m* , *s* ,
 | |tab| *g_hat* , *g_jac* , *hessian* , *bound* , *epsilon* , *maxitr* , *delta_x*

example/abs_normal/abs_print_mat.hpp

@@ -2,7 +2,7 @@
 # define CPPAD_EXAMPLE_ABS_NORMAL_ABS_PRINT_MAT_HPP
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 /*
 {xrst_begin abs_print_mat}
@@ -15,7 +15,7 @@ abs_normal: Print a Vector or Matrix
 
 Syntax
 ******
-``abs_print_mat`` ( *name* , *nr* , *nc* , *mat* )
+| ``abs_print_mat`` ( *name* , *nr* , *nc* , *mat* )
 
 Prototype
 *********

example/abs_normal/lp_box.hpp

@@ -2,7 +2,7 @@
 # define CPPAD_EXAMPLE_ABS_NORMAL_LP_BOX_HPP
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 /*
 {xrst_begin lp_box}
@@ -16,7 +16,6 @@ abs_normal: Solve a Linear Program With Box Constraints
 
 Syntax
 ******
-
 | *ok* = ``lp_box`` (
 | |tab| *level* , *A* , *b* , *c* , *d* , *maxitr* , *xout*
 | )

example/abs_normal/min_nso_linear.hpp

@@ -2,7 +2,7 @@
 # define CPPAD_EXAMPLE_ABS_NORMAL_MIN_NSO_LINEAR_HPP
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 /*
 {xrst_begin min_nso_linear}
@@ -15,7 +15,6 @@ Non-Smooth Optimization Using Abs-normal Linear Approximations
 
 Syntax
 ******
-
 | *ok* = ``min_nso_linear`` (
 | |tab| *level* , *g* , *a* , *epsilon* , *maxitr* , *b_in* , *x_in* , *x_out*
 | )

example/abs_normal/min_nso_quad.hpp

@@ -15,7 +15,6 @@ Non-Smooth Optimization Using Abs-normal Quadratic Approximations
 
 Syntax
 ******
-
 | *ok* = ``min_nso_quad`` (
 | |tab| *level* , *f* , *g* , *a* , *epsilon* , *maxitr* , *b_in* , *x_in* , *x_out*
 | )

example/abs_normal/qp_box.hpp

@@ -2,7 +2,7 @@
 # define CPPAD_EXAMPLE_ABS_NORMAL_QP_BOX_HPP
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 /*
 {xrst_begin qp_box}
@@ -17,7 +17,6 @@ abs_normal: Solve a Quadratic Program With Box Constraints
 
 Syntax
 ******
-
 | *ok* = ``qp_box`` (
 | |tab| *level* , *a* , *b* , *c* , *C* , *g* , *G* , *epsilon* , *maxitr* , *xin* , *xout*
 | )

example/abs_normal/qp_interior.hpp

@@ -20,7 +20,6 @@ Solve a Quadratic Program Using Interior Point Method
 
 Syntax
 ******
-
 | *ok* = ``qp_interior`` (
 | *level* , *c* , *C* , *g* , *G* , *epsilon* , *maxitr* , *xin* , *xout* , *yout* , *sout*
 | )

example/abs_normal/simplex_method.hpp

@@ -2,7 +2,7 @@
 # define CPPAD_EXAMPLE_ABS_NORMAL_SIMPLEX_METHOD_HPP
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 /*
 {xrst_begin simplex_method}
@@ -17,8 +17,7 @@ abs_normal: Solve a Linear Program Using Simplex Method
 
 Syntax
 ******
-
-   *ok* = ``simplex_method`` ( *level* , *b* , *A* , *c* , *maxitr* , *xout* )
+| *ok* = ``simplex_method`` ( *level* , *b* , *A* , *c* , *maxitr* , *xout* )
 
 Prototype
 *********

example/general/lu_vec_ad.cpp

@@ -16,7 +16,6 @@ Lu Factor and Solve with Recorded Pivoting
 
 Syntax
 ******
-
 | ``int lu_vec_ad`` (
 | |tab| ``size_t`` *n* ,
 | |tab| ``size_t`` *m* ,

example/json/get_started.cpp

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 /*
 {xrst_begin json_get_started.cpp}
@@ -50,7 +50,7 @@ Include the CppAD core functions:
 
 Syntax
 ******
-*ok* = ``get_started`` ()
+| *ok* = ``get_started`` ()
 {xrst_spell_off}
 {xrst_code cpp} */
 bool get_started(void)

example/multi_thread/harmonic.cpp

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 /*
 {xrst_begin harmonic_common}
@@ -75,8 +75,7 @@ Set Up Multi-threading Sum of 1/i
 
 Syntax
 ******
-
-   *ok* = ``harmonic_setup`` ( *num_sum* )
+| *ok* = ``harmonic_setup`` ( *num_sum* )
 
 Purpose
 *******

example/multi_thread/multi_atomic_three.cpp

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 
 /*
@@ -14,10 +14,8 @@ Defines a atomic_three Operation that Computes Square Root
 
 Syntax
 ******
-
-   ``atomic_user`` *a_square_root*
-
-*a_square_root* ( *au* , *ay* )
+| ``atomic_user`` *a_square_root*
+| *a_square_root* ( *au* , *ay* )
 
 Purpose
 *******

example/multi_thread/multi_atomic_two.cpp

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
 // SPDX-FileCopyrightText: Bradley M. Bell <[email protected]>
-// SPDX-FileContributor: 2003-22 Bradley M. Bell
+// SPDX-FileContributor: 2003-24 Bradley M. Bell
 // ----------------------------------------------------------------------------
 
 /*
@@ -14,10 +14,8 @@ Defines a atomic_two Operation that Computes Square Root
 
 Syntax
 ******
-
-   ``atomic_user`` *a_square_root*
-
-*a_square_root* ( *au* , *ay* )
+| ``atomic_user`` *a_square_root*
+| *a_square_root* ( *au* , *ay* )
 
 Purpose
 *******