Merge pull request #1960 from CEED/jeremy/changelog

Minor Doc Fixes

Author: jeremylt

.github/workflows/release-notes.yml

@@ -22,7 +22,7 @@ jobs:
         git fetch origin main
         if git diff origin/main --exit-code include/ceed/*; then
           echo "No public interface changes detected"
-        elif git diff origin/main --exit-code doc/sphinx/source/releasenotes.rst; then
+        elif git diff origin/main --exit-code CHANGELOG.md; then
           echo "API changes detected, but release notes not updated"
           exit 1
         fi

doc/sphinx/source/releasenotes.md CHANGELOG.mddoc/sphinx/source/releasenotes.md renamed to CHANGELOG.md

@@ -1127,7 +1127,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = ./README.md
+USE_MDFILE_AS_MAINPAGE =
 
 # The Fortran standard specifies that for fixed formatted Fortran code all
 # characters from position 72 are to be considered as comment. A common

Doxyfile

@@ -0,0 +1 @@
+../../../CHANGELOG.md

doc/sphinx/source/CHANGELOG.md

@@ -100,13 +100,9 @@
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
 exclude_patterns = [
+    "doc/README.md",
     "examples/README.md",
-    "examples/ceed/README.md",
-    "examples/fluids/README.md",
-    "examples/nek/README.md",
-    "examples/petsc/README.md",
-    "examples/solid/README.md",
-    "examples/deal.II/README.md",
+    "examples/*/README.md",
 ]
 
 # The name of the Pygments (syntax highlighting) style to use.

doc/sphinx/source/conf.py

@@ -15,7 +15,7 @@ precision
 libCEEDdev
 Contributing <CONTRIBUTING>
 Code of Conduct <CODE_OF_CONDUCT>
-releasenotes
+Release Notes <CHANGELOG>
 ```
 
 # Indices and tables

doc/sphinx/source/index.md

@@ -13,7 +13,7 @@ For more details, please see the dedicated [documentation section](https://libce
 
 The Center for Efficient Exascale Discretizations (CEED) uses Bakeoff Problems (BPs) to test and compare the performance of high-order finite element implementations.
 The definitions of the problems are given on the ceed [website](https://ceed.exascaleproject.org/bps/).
-Each of the following bakeoff problems that use external discretization libraries (such as deal.II, MFEM, PETSc, and Nek5000) are located in the subdirectories `deal.II/`, `mfem/`, `petsc/`, and `nek5000/`, respectively.
+Each of the following bakeoff problems that use external discretization libraries (such as deal.II, MFEM, PETSc, and Nek5000) are located in the directories `examples/deal.II/`, `examples/mfem/`, `examples/nek5000/`, and `examples/petsc/`, respectively.
 
 Here we provide a short summary:
 
@@ -32,16 +32,16 @@ Here we provide a short summary:
 * - `mfem`
   - * BP1 (scalar mass operator) with $Q=P+1$
     * BP3 (scalar Laplace operator) with $Q=P+1$
+* - `nek5000`
+  - * BP1 (scalar mass operator) with $Q=P+1$
+    * BP3 (scalar Laplace operator) with $Q=P+1$
 * - `petsc`
   - * BP1 (scalar mass operator) with $Q=P+1$
     * BP2 (vector mass operator) with $Q=P+1$
     * BP3 (scalar Laplace operator) with $Q=P+1$
     * BP4 (vector Laplace operator) with $Q=P+1$
     * BP5 (collocated scalar Laplace operator) with $Q=P$
     * BP6 (collocated vector Laplace operator) with $Q=P$
-* - `nek5000`
-  - * BP1 (scalar mass operator) with $Q=P+1$
-    * BP3 (scalar Laplace operator) with $Q=P+1$
 :::
 
 These are all **T-vector**-to-**T-vector** and include parallel scatter, element scatter, element evaluation kernel, element gather, and parallel gather (with the parallel gathers/scatters done externally to libCEED).

examples/README.md

@@ -49,9 +49,9 @@ each defined for index sets $i,j \; \in \; \{1,\dots,n\}$.
 
 (laplace-operator)=
 
-## Laplace's Operator
+## Laplace Operator
 
-The Laplace's operator used in BP3-BP6 is defined via the following variational formulation, i.e., find $u \in V^p$ such that for all $v \in V^p$
+The Laplace operator used in BP3-BP6 is defined via the following variational formulation, i.e., find $u \in V^p$ such that for all $v \in V^p$
 
 $$
 a(v,u) = \langle v,f \rangle , \,

examples/bps.md

@@ -1,16 +1,16 @@
-## libCEED Basic Examples
+# libCEED Basic Examples
 
 Two examples are provided that rely only upon libCEED without any external libraries.
 
-### Example 1: ex1-volume
+## Example 1: ex1-volume
 
 This example uses the mass matrix to compute the length, area, or volume of a region, depending upon runtime parameters.
 
-### Example 2: ex2-surface
+## Example 2: ex2-surface
 
 This example uses the diffusion matrix to compute the surface area of a region, in 1D, 2D or 3D, depending upon runtime parameters.
 
-### Example 3: ex3-volume
+## Example 3: ex3-volume
 
 This example uses the mass matrix to compute the length, area, or volume of a region, depending upon runtime parameters.
 Unlike ex1, this example also adds the diffusion matrix to add a zero contribution to this calculation while demonstrating the ability of libCEED to handle multiple basis evaluation modes on the same input and output vectors.

examples/ceed/README.md

@@ -1,4 +1,4 @@
-## libCEED deal.II Example
+# libCEED deal.II Example
 
 An example how to write libCEED operators (BP1-BP6) within the open-source finite element library [deal.II](https://www.dealii.org/).
 As reference, operators are presented that use the native matrix-free infrastructure.