Merge pull request #748 from CEED/jed/doc-linking

Improve documentation linking

Author: jedbrown

doc/sphinx/source/conf.py

@@ -272,7 +272,7 @@ def katex_cdn(path):
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    'python': ('https://docs.python.org', None),
+    'python': ('https://docs.python.org/3', None),
     'numpy': ('https://numpy.org/devdocs', None),
 }
 

doc/sphinx/source/releasenotes.rst

@@ -17,6 +17,8 @@ Interface changes
 New features
 ^^^^^^^^^^^^
 
+* Add :c:func:`CeedVectorAXPY` and :c:func:`CeedVectorPointwiseMult` as a convenience for stand-alone testing and internal use.
+
 Performance improvements
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -38,7 +40,7 @@ New features
 ^^^^^^^^^^^^
 * Julia and Rust interfaces added, providing a nearly 1-1 correspondence with the C interface, plus some convenience features.
 * Static libraries can be built with ``make STATIC=1`` and the pkg-config file is installed accordingly.
-* Add :cpp:func:`CeedOperatorLinearAssembleSymbolic` and :cpp:func:`CeedOperatorLinearAssemble` to support full assembly of libCEED operators.
+* Add :c:func:`CeedOperatorLinearAssembleSymbolic` and :c:func:`CeedOperatorLinearAssemble` to support full assembly of libCEED operators.
 
 Performance improvements
 ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -63,14 +65,14 @@ Interface changes
   As a result, the :code:`indices` parameter has been replaced with :code:`offsets` and the :code:`nnodes` parameter has been replaced with :code:`lsize`.
   These changes improve support for mixed finite element methods.
 * Replace various uses of :code:`Ceed*Get*Status` with :code:`Ceed*Is*` in the backend API to match common nomenclature.
-* Replace :code:`CeedOperatorAssembleLinearDiagonal` with :cpp:func:`CeedOperatorLinearAssembleDiagonal` for clarity.
-* Linear Operators can be assembled as point-block diagonal matrices with :cpp:func:`CeedOperatorLinearAssemblePointBlockDiagonal`, provided in row-major form in a :code:`ncomp` by :code:`ncomp` block per node.
+* Replace :code:`CeedOperatorAssembleLinearDiagonal` with :c:func:`CeedOperatorLinearAssembleDiagonal` for clarity.
+* Linear Operators can be assembled as point-block diagonal matrices with :c:func:`CeedOperatorLinearAssemblePointBlockDiagonal`, provided in row-major form in a :code:`ncomp` by :code:`ncomp` block per node.
 * Diagonal assemble interface changed to accept a :ref:`CeedVector` instead of a pointer to a :ref:`CeedVector` to reduce memory movement when interfacing with calling code.
-* Added :cpp:func:`CeedOperatorLinearAssembleAddDiagonal` and :cpp:func:`CeedOperatorLinearAssembleAddPointBlockDiagonal` for improved future integration with codes such as MFEM that compose the action of :ref:`CeedOperator`\s external to libCEED.
-* Added :cpp:func:`CeedVectorTakeAray` to sync and remove libCEED read/write access to an allocated array and pass ownership of the array to the caller.
-  This function is recommended over :cpp:func:`CeedVectorSyncArray` when the :code:`CeedVector` has an array owned by the caller that was set by :cpp:func:`CeedVectorSetArray`.
+* Added :c:func:`CeedOperatorLinearAssembleAddDiagonal` and :c:func:`CeedOperatorLinearAssembleAddPointBlockDiagonal` for improved future integration with codes such as MFEM that compose the action of :ref:`CeedOperator`\s external to libCEED.
+* Added :c:func:`CeedVectorTakeAray` to sync and remove libCEED read/write access to an allocated array and pass ownership of the array to the caller.
+  This function is recommended over :c:func:`CeedVectorSyncArray` when the :code:`CeedVector` has an array owned by the caller that was set by :c:func:`CeedVectorSetArray`.
 * Added :code:`CeedQFunctionContext` object to manage user QFunction context data and reduce copies between device and host memory.
-* Added :cpp:func:`CeedOperatorMultigridLevelCreate`, :cpp:func:`CeedOperatorMultigridLevelCreateTensorH1`, and :cpp:func:`CeedOperatorMultigridLevelCreateH1` to facilitate creation of multigrid prolongation, restriction, and coarse grid operators using a common quadrature space.
+* Added :c:func:`CeedOperatorMultigridLevelCreate`, :c:func:`CeedOperatorMultigridLevelCreateTensorH1`, and :c:func:`CeedOperatorMultigridLevelCreateH1` to facilitate creation of multigrid prolongation, restriction, and coarse grid operators using a common quadrature space.
 
 New features
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -106,15 +108,15 @@ New features
   :py:class:`numpy.ndarray`.  Short tutorials are provided in
   `Binder <https://mybinder.org/v2/gh/CEED/libCEED/main?urlpath=lab/tree/examples/tutorials/>`_.
 * Linear QFunctions can be assembled as block-diagonal matrices (per quadrature point,
-  :cpp:func:`CeedOperatorAssembleLinearQFunction`) or to evaluate the diagonal
-  (:cpp:func:`CeedOperatorAssembleLinearDiagonal`).  These operations are useful for
+  :c:func:`CeedOperatorAssembleLinearQFunction`) or to evaluate the diagonal
+  (:c:func:`CeedOperatorAssembleLinearDiagonal`).  These operations are useful for
   preconditioning ingredients and are used in the libCEED's multigrid examples.
 * The inverse of separable operators can be obtained using
-  :cpp:func:`CeedOperatorCreateFDMElementInverse` and applied with
-  :cpp:func:`CeedOperatorApply`.  This is a useful preconditioning ingredient,
+  :c:func:`CeedOperatorCreateFDMElementInverse` and applied with
+  :c:func:`CeedOperatorApply`.  This is a useful preconditioning ingredient,
   especially for Laplacians and related operators.
-* New functions: :cpp:func:`CeedVectorNorm`, :cpp:func:`CeedOperatorApplyAdd`,
-  :cpp:func:`CeedQFunctionView`, :cpp:func:`CeedOperatorView`.
+* New functions: :c:func:`CeedVectorNorm`, :c:func:`CeedOperatorApplyAdd`,
+  :c:func:`CeedQFunctionView`, :c:func:`CeedOperatorView`.
 * Make public accessors for various attributes to facilitate writing composable code.
 * New backend: ``/cpu/self/memcheck/serial``.
 * QFunctions using variable-length array (VLA) pointer constructs can be used with CUDA
@@ -124,20 +126,20 @@ New features
 Performance Improvements
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 * MAGMA backend performance optimization and non-tensor bases.
-* No-copy optimization in :cpp:func:`CeedOperatorApply`.
+* No-copy optimization in :c:func:`CeedOperatorApply`.
 
 Interface changes
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 * Replace :code:`CeedElemRestrictionCreateIdentity` and
   :code:`CeedElemRestrictionCreateBlocked` with more flexible
-  :cpp:func:`CeedElemRestrictionCreateStrided` and
-  :cpp:func:`CeedElemRestrictionCreateBlockedStrided`.
-* Add arguments to :cpp:func:`CeedQFunctionCreateIdentity`.
+  :c:func:`CeedElemRestrictionCreateStrided` and
+  :c:func:`CeedElemRestrictionCreateBlockedStrided`.
+* Add arguments to :c:func:`CeedQFunctionCreateIdentity`.
 * Replace ambiguous uses of :cpp:enum:`CeedTransposeMode` for L-vector identification
   with :cpp:enum:`CeedInterlaceMode`.  This is now an attribute of the
-  :cpp:type:`CeedElemRestriction` (see :cpp:func:`CeedElemRestrictionCreate`) and no
-  longer passed as ``lmode`` arguments to :cpp:func:`CeedOperatorSetField` and
-  :cpp:func:`CeedElemRestrictionApply`.
+  :cpp:type:`CeedElemRestriction` (see :c:func:`CeedElemRestrictionCreate`) and no
+  longer passed as ``lmode`` arguments to :c:func:`CeedOperatorSetField` and
+  :c:func:`CeedElemRestrictionApply`.
 
 Examples
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^