Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation #523

Merged
merged 3 commits into from
Feb 3, 2025
Merged

Fix documentation #523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
00f5bcf
Fix documentation
jbigot Jan 24, 2025
cc6ca2e
Update README.md
jbigot Jan 29, 2025
085ea8d
Update README.md
jbigot Jan 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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,
Expand Down
5 changes: 5 additions & 0 deletions pdi/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pdi/docs/Doxyfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 =
Expand Down
26 changes: 21 additions & 5 deletions pdi/docs/_template/header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,35 @@
<!DOCTYPE html>
<html>
<html lang="$langISO">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen $doxygenversion"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PDI: $title</title>
$mathjax
<!--BEGIN PROJECT_ICON-->
<link rel="icon" href="$relpath^$projecticon" type="image/x-icon" />
<!--END PROJECT_ICON-->
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript">var page_layout=1;</script>
<script type="text/javascript" src="$relpath^jquery.js"></script>
<script type="text/javascript" src="$relpath^dynsections.js"></script>
<script type="text/javascript" src="$relpath^navtreedata.js"></script>
<script type="text/javascript" src="$relpath^navtree.js"></script>
<!--BEGIN COPY_CLIPBOARD-->
<script type="text/javascript" src="$relpath^clipboard.js"></script>
<!--END COPY_CLIPBOARD-->
$treeview
$search
$darkmode
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
$extrastylesheet
</head>
<body>
<div>
<!--BEGIN DISABLE_INDEX-->
<!--BEGIN FULL_SIDEBAR-->
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
<!--END FULL_SIDEBAR-->
<!--END DISABLE_INDEX-->
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<header id="titlearea">
<div id="projectlogo"><a href="index.html"><img alt="Logo" src="$relpath^$projectlogo"/></a></div>
<h1 id="projectname">PDI&nbsp;<span id="projectnumber">$projectnumber</span></h1>
Expand All @@ -30,5 +46,5 @@ <h2 id="projectbrief">the <span class="acronym">P</span>DI <span class="acronym"
<li><a href="modules.html">C API reference</a>
<li><a href="Specification_tree_ref.html">Specification tree</a>
<li><a href="Plugins.html">Plugins</a>
<li id="github-ribbon"><a rel="noopener" href="https://github.pdi.dev/pdi" target="_blank">⭐⭐⭐Star us⭐⭐⭐, or contribute on GitHub</a></li>
<li id="github-ribbon"><a rel="noopener" href="https://github.pdi.dev" target="_blank">⭐Star us on GitHub</a></li>
</ul></nav>
2 changes: 1 addition & 1 deletion pdi/docs/_template/style.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1178,7 +1178,7 @@ a[id]
{
max-width: 52rem;
padding: 0;
margin: 0 15rem 0 0;
margin: 0 15rem 0 0 !important;
}

@media (max-width: 68rem)
Expand Down