create experimental docs section

m3g · Jul 11, 2024 · 27fb355 · 27fb355
1 parent a0bc00a
commit 27fb355
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -19,7 +19,8 @@ makedocs(
         "Miscelaneous functions" => "miscelaneous.md",
         "Developer zone" => "Developer.md",
         "Plotting style" => "plotting_style.md",
-        "Simulation Reweight" => "Reweighting.md"
+        "Experimental" => "Experimental.md",
+        " ∘ Simulation Reweighting" => "Reweighting.md",
     ],
 )
 deploydocs(

diff --git a/docs/src/Experimental.md b/docs/src/Experimental.md
@@ -0,0 +1,9 @@
+# Experimental features
+
+The features in this section are experimental, meaning that they are under
+active development, with possible early bugs and unstable interfaces. The
+semantic version of the package is not compromised to the changes of these
+features. 
+
+- [Simulation reweighting](@ref simulation_reweighting)
+
diff --git a/docs/src/Reweighting.md b/docs/src/Reweighting.md
@@ -1,8 +1,9 @@
+# [Simulation Reweighting](@id simulation_reweighting)
+
 !!! warning
     This is an experimental feature. Breaking changes may occur without 
     a breaking package release.
 
-# Simulation Reweighting
 Computes the new weight for a frame of a simulation based on the energy difference between the perturbed and non-perturbed original sampling
 
 This resource is based on the Free Energy Perturbation Theory (FEP) in the Molecular Dynamics context. Most of the time, each frame will contribute equally