diff --git a/README.md b/README.md index ad06f8c7..94fcebe7 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # The PDI distribution -This is the PDI source distribution, including PDI (the PDI Data Interface) and -its bindings for Fortran and python, the PDI plugins, the PDI configuration -validator, examples and tests, as well as many dependencies of all those. +This is the PDI source distribution, including PDI (the PDI Data Interface), its +bindings for Fortran and python, the PDI plugins, examples and tests, +documentation, as well as many dependencies of all those. PDI is a library that aims to decouple high-performance simulation codes from Input/Output concerns. @@ -25,20 +25,21 @@ The on-line PDI documentation is available at https://pdi.dev ## Installation -**The recommended approach to install PDI is to use the stable [pre-compiled binary packages for Debian, Fedora and Ubuntu](https://github.com/pdidev/pkgs/tree/repo).** +**The recommended approach to install PDI is to use the stable [pre-compiled binary packages for Debian, Fedora and Ubuntu](https://repo.pdi.dev).** -On other distributions, in case you do not have root access, or if you want a -more recent version, [**PDI spack recipe**](https://github.com/pdidev/spack) can -be used. +On other distributions, or in case you do not have root access, +[**PDI spack recipe**](https://github.com/pdidev/spack) can be used. In case you don't want to use either option, you can install PDI source distribution using the dedicated -[installation instructions](https://pdi.julien-bigot.fr/master/Installation.html). +[installation instructions](https://pdi.dev/main/Installation.html). ## Content PDI distribution is made of the following submodules: -* `CMakeLists.txt`, `LICENSE`, `cmake/`, `README.md`: distribution specific files, +* `AUTHORS`, `CHANGELOG.md`, `CMakeLists.txt`, `LICENSE`, `PACKAGING.md`, + `README.md`, `bin`, `cmake/`, `spack.yaml`: distribution specific files and + directories, * `pdi/` : the PDI library, * `plugins/decl_hdf5/`: the Decl'HDF5 plugin, * `plugins/decl_netcdf/`: the Decl'NetCDF plugin, diff --git a/pdi/CHANGELOG.md b/pdi/CHANGELOG.md index c8b9af26..ac7d99a9 100644 --- a/pdi/CHANGELOG.md +++ b/pdi/CHANGELOG.md @@ -11,6 +11,11 @@ and this project adheres to +## [1.8.2] - TODO +* Fix documentation generation, add sidepanel & fix repository URL, fixes + [#521](https://github.com/pdidev/pdi/issues/521) and + [#522](https://github.com/pdidev/pdi/issues/522) + ## [1.8.1] - 2025-01-23 ### For users diff --git a/pdi/docs/Doxyfile b/pdi/docs/Doxyfile index 4c8f9fd7..307768ee 100644 --- a/pdi/docs/Doxyfile +++ b/pdi/docs/Doxyfile @@ -307,7 +307,7 @@ DIRECTORY_GRAPH = YES DIR_GRAPH_MAX_DEPTH = 1 DOT_IMAGE_FORMAT = png INTERACTIVE_SVG = NO -DOT_PATH = /usr/bin +DOT_PATH = DOTFILE_DIRS = DIA_PATH = DIAFILE_DIRS = diff --git a/pdi/docs/_template/header.html b/pdi/docs/_template/header.html index f3045bcd..30b23f54 100644 --- a/pdi/docs/_template/header.html +++ b/pdi/docs/_template/header.html @@ -1,19 +1,35 @@ - +
+