add reference page

m3g · Sep 12, 2023 · 17e109e · 17e109e
1 parent d789689
commit 17e109e
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 10 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -11,6 +11,7 @@ makedocs(
         "Basic use" => "basic.md",
         "Advanced use" => "advanced.md",
         "Reference" => "reference.md",
+        "Citation" => "citation.md",
     ],
 )
 deploydocs(

diff --git a/docs/src/citation.md b/docs/src/citation.md
@@ -0,0 +1,10 @@
+# Citation
+
+If this package was useful, please cite the article describing the main
+algorithms on which it is based:
+
+L. Martínez, **CellListMap.jl: Efficient and customizable cell list implementation for calculation of pairwise particle properties within a cutoff.**
+*Computer Physics Communications* **279**, 108452 (2022). 
+
+DOI: [10.1016/j.cpc.2022.108452](https://doi.org/10.1016/j.cpc.2022.108452)
+
diff --git a/docs/src/reference.md b/docs/src/reference.md
@@ -1,10 +1,14 @@
-# Citation
-
-If this package was useful, please cite the article describing the main
-algorithms on which it is based:
-
-L. Martínez, **CellListMap.jl: Efficient and customizable cell list implementation for calculation of pairwise particle properties within a cutoff.**
-*Computer Physics Communications* **279**, 108452 (2022). 
-
-DOI: [10.1016/j.cpc.2022.108452](https://doi.org/10.1016/j.cpc.2022.108452)
-
+# Interface reference
+
+```@autodocs
+Modules = [ MolecularMinimumDistances ]
+Order = [ :function, :struct ]
+Filter = (f) -> (nameof(f) in (
+    :minimum_distances,
+    :minimum_distances!,
+    :MinimumDistance,
+    :AllPairs,
+    :SelfPairs,
+    :CrossPairs,
+))
+```