diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index ce35a03ff..01975809c 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -77,13 +77,14 @@ set(DOXYGEN_HTML_EXTRA_FILES doxygen_add_docs( doc - "${CMAKE_CURRENT_SOURCE_DIR}/About.md" + "${CMAKE_CURRENT_SOURCE_DIR}/about.md" "${CMAKE_CURRENT_SOURCE_DIR}/first_steps.md" "${CMAKE_CURRENT_SOURCE_DIR}/going_further.md" "${CMAKE_CURRENT_SOURCE_DIR}/uniform_heat_equation.md" "${CMAKE_CURRENT_SOURCE_DIR}/non_uniform_heat_equation.md" "${CMAKE_CURRENT_SOURCE_DIR}/concepts.md" "${CMAKE_CURRENT_SOURCE_DIR}/heat_equation_spectral.md" + "${CMAKE_CURRENT_SOURCE_DIR}/examples.md" "${DDC_SOURCE_DIR}/include/ddc/" ALL ) diff --git a/docs/About.md b/docs/about.md similarity index 100% rename from docs/About.md rename to docs/about.md index d6c45cb86..08ecfd0c9 100644 --- a/docs/About.md +++ b/docs/about.md @@ -1,11 +1,11 @@ +# About {#mainpage} + -# About {#mainpage} - %DDC is the discrete domain computation library, a C++-17 library that aims to offer to the C++/MPI world an equivalent to the [`xarray.DataArray`](https://docs.xarray.dev/en/stable/generated/xarray.DataArray.html)/[`dask.Array`](https://docs.dask.org/en/stable/array.html) diff --git a/docs/concepts.md b/docs/concepts.md index d0e47e4d9..b517d75e4 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -1,11 +1,11 @@ +# DDC concepts + -# DDC concepts - DDC introduces labels in the form of dimensions and attributes on top of Kokkos arrays, which offer a more intuitive and less error-prone development experience. Using Kokkos, the indices of views are weakly typed, meaning that each index is a simple integer. Let's consider a multidimensional view intended to represent a physical quantity, such as a temperature field for example. The first index represents the temperature along the \f$x\f$ axis, and the second index represents the temperature along the \f$y\f$ axis. As both indices are simple integers, they may be swapped by mistake. The code would compile successfully, but the result would be incorrect, and the source of the error would be difficult to trace. diff --git a/docs/examples.md b/docs/examples.md new file mode 100644 index 000000000..b6c953b2d --- /dev/null +++ b/docs/examples.md @@ -0,0 +1,11 @@ +# Examples + + + +- \subpage first_steps +- \subpage going_further +- \subpage heat_equation_spectral diff --git a/docs/first_steps.md b/docs/first_steps.md index 4935bf9dc..b2405f6b6 100644 --- a/docs/first_steps.md +++ b/docs/first_steps.md @@ -1,11 +1,11 @@ +# The uniform heat equation {#first_steps} + -# Commented example: the uniform heat equation {#first_steps} - In \subpage uniform_heat_equation "examples/uniform_heat_equation.cpp" is a DDC example implementing a forward finite-difference solver for the heat equation over a rectangle 2D domain with periodic boundary conditions. diff --git a/docs/going_further.md b/docs/going_further.md index 5f92a41ea..2de0821da 100644 --- a/docs/going_further.md +++ b/docs/going_further.md @@ -1,11 +1,11 @@ +# The non uniform heat equation {#going_further} + -# Commented example: the non uniform heat equation {#going_further} - In \subpage non_uniform_heat_equation "examples/non_uniform_heat_equation.cpp" is a DDC example implementing a forward finite-difference solver for the heat equation over a rectangle 2D domain with periodic boundary conditions and non-uniform space discretization. diff --git a/docs/heat_equation_spectral.md b/docs/heat_equation_spectral.md index d886cba2b..3f4dc1b59 100644 --- a/docs/heat_equation_spectral.md +++ b/docs/heat_equation_spectral.md @@ -1,9 +1,9 @@ +# examples/heat_equation_spectral.cpp {#heat_equation_spectral} + -# examples/heat_equation_spectral.cpp {#heat_equation_spectral} - \include{lineno} heat_equation_spectral.cpp diff --git a/docs/non_uniform_heat_equation.md b/docs/non_uniform_heat_equation.md index 16620cf4a..44015dab6 100644 --- a/docs/non_uniform_heat_equation.md +++ b/docs/non_uniform_heat_equation.md @@ -1,9 +1,9 @@ +# examples/non_uniform_heat_equation.cpp {#non_uniform_heat_equation} + -# examples/non_uniform_heat_equation.cpp {#non_uniform_heat_equation} - \include{lineno} non_uniform_heat_equation.cpp diff --git a/docs/uniform_heat_equation.md b/docs/uniform_heat_equation.md index 900a06712..8aea693ec 100644 --- a/docs/uniform_heat_equation.md +++ b/docs/uniform_heat_equation.md @@ -1,9 +1,9 @@ +# examples/uniform_heat_equation.cpp {#uniform_heat_equation} + -# examples/uniform_heat_equation.cpp {#uniform_heat_equation} - \include{lineno} uniform_heat_equation.cpp