CompatHelper: bump compat for Documenter to 1 for package docs (#280)

* CompatHelper: bump compat for Documenter to 1 for package docs * [docs] Add missing docstrings --------- Co-authored-by: CompatHelper Julia <[email protected]> Co-authored-by: Mosè Giordano <[email protected]>
Team-RADDISH · Nov 15, 2024 · 3bc946d · 3bc946d
1 parent c55ea63
commit 3bc946d
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -16,7 +16,7 @@ YAML = "ddb6d928-2868-570f-bddf-ab3f9cf99eb6"
 [compat]
 DelimitedFiles = "1"
 Distributions = "0.22, 0.23, 0.24, 0.25"
-Documenter = "~0.26, 0.27"
+Documenter = "1"
 GaussianRandomFields = "2.1.1"
 HDF5 = "0.14, 0.15, 0.16, 0.17"
 MPI = "0.20"

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -118,6 +118,21 @@ ParticleDA.get_covariance_state_observation_given_previous_state
 ParticleDA.get_covariance_observation_observation_given_previous_state
 ```
 
+### Other function you may want to extend
+
+```@docs
+ParticleDA.get_state_indices_correlated_to_observations
+ParticleDA.get_initial_state_mean!
+ParticleDA.write_snapshot
+ParticleDA.write_state
+ParticleDA.get_covariance_initial_state
+ParticleDA.init_filter
+ParticleDA.sample_proposal_and_compute_log_weights!
+ParticleDA.write_observation
+ParticleDA.write_weights
+ParticleDA.get_initial_state_mean
+```
+
 ### Input parameters
 
 You can store the input parameters in an YAML file with the following structure