Misc doc

nansencenter · Nov 1, 2024 · dadd67e · dadd67e
1 parent a3ebf3e
commit dadd67e
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 17 deletions.
diff --git a/dapper/README.md b/dapper/README.md
@@ -1,4 +1,4 @@
-##### Adding your own model/method
+## Adding your own model/method
 
 If you wish to illustrate and run benchmarks with
 your own **model** or **method**, then

diff --git a/dapper/dpr_config.py b/dapper/dpr_config.py
@@ -1,8 +1,14 @@
 """Load default and user configurations into the `rc` dict.
 
-The `rc` dict can be updated (after startup) as any normal dict. See the
-[source](https://github.com/nansencenter/DAPPER/blob/master/dapper/dpr_config.yaml)
-for the default configuration.
+The `rc` dict can be updated (after startup) as any normal dict.
+
+The config file should reside in your `$HOME/`, or `$HOME/.config/` or `$PWD/`.
+If several exist, the last one found (from the above ordering) is used.
+The default configuration is given below.
+
+```yaml
+--8<-- "dapper/dpr_config.yaml"
+```
 """
 
 import os

diff --git a/dapper/dpr_config.yaml b/dapper/dpr_config.yaml
@@ -1,8 +1,3 @@
-# DAPPER configuration file. DO NOT MODIFY.
-# Instead, overrule it by putting a copy of this file
-# in your $HOME/, or $HOME/.config/ or $PWD/.
-# The order of precendence is (the reverse of) the above.
-
 # Where to store the experimental settings and results.
 # For example, you don't want this to be in your Dropbox.
 # Use "$cwd" for PWD, "$dapper" for where the DAPPER dir is.

diff --git a/dapper/stats_etc.md b/dapper/stats_etc.md
@@ -20,13 +20,8 @@ The same applies for the time-averages of `.avrgs`.
 ### Field summaries
 
 The statistics are also averaged in space.
-This is done according to the methods listed in `dpr.rc.field_summaries`.
-
-!!! note
-
-    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
-    nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
-    massa, nec semper lorem quam in massa.
+This is done according to the methods listed in
+`rc.field_summaries` of the [`dpr_config`][].
 
 !!! note
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -10,8 +10,8 @@ nav:
   - Home: index.md
   - Reference: reference/
   - Examples: examples/
-  - dev_guide.md
   - Bibliography: references.md
+  - dev_guide.md
 
 validation:
   absolute_links: relative_to_docs