Update API structure and Ruff lint ignore

VeckoTheGecko · VeckoTheGecko · commit 7e419d3c256d · 2024-08-27T11:14:45.000+02:00
diff --git a/docs/index.rst b/docs/index.rst
@@ -55,5 +55,5 @@ If you would like support using ``plasticparcels``, or are have any questions ab
    Examples <examples>
    Physics kernels <physicskernels>
    Plastic initialisation maps <initialisationmaps>
-   API reference <reference>
+   API reference <reference/index>
    OceanParcels website <https://oceanparcels.org/>
diff --git a/docs/reference.rst b/docs/reference.rst
diff --git a/docs/reference/constructors.rst b/docs/reference/constructors.rst
@@ -0,0 +1,6 @@
+plasticparcels.constructors
+---------------------------
+
+.. automodule:: plasticparcels.constructors
+    :members:
+    :show-inheritance: yes
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -0,0 +1,10 @@
+API
+===
+
+.. toctree::
+  :maxdepth: 2
+
+  plasticparcels.constructors <constructurs>
+  plasticparcels.kernels <kernels>
+  plasticparcels.particlefile <particlefile>
+  plasticparcels.utils <utils>
diff --git a/docs/reference/kernels.rst b/docs/reference/kernels.rst
@@ -0,0 +1,6 @@
+plasticparcels.kernels
+---------------------------
+
+.. automodule:: plasticparcels.kernels
+    :members:
+    :show-inheritance: yes
diff --git a/docs/reference/particlefile.rst b/docs/reference/particlefile.rst
@@ -0,0 +1,6 @@
+plasticparcels.particlefile
+---------------------------
+
+.. automodule:: plasticparcels.particlefile
+    :members:
+    :show-inheritance: yes
diff --git a/docs/reference/utils.rst b/docs/reference/utils.rst
@@ -0,0 +1,6 @@
+plasticparcels.utils
+---------------------------
+
+.. automodule:: plasticparcels.utils
+    :members:
+    :show-inheritance: yes
diff --git a/pyproject.toml b/pyproject.toml
@@ -58,6 +58,11 @@ select = [
     "DOC", # pydoclint
 ]
 
+exclude = [
+    "docs/*",
+    "plasticparcels/scripts/*",
+]
+
 # If updating to use a formatter, look at https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules for rules to add to ignore
 ignore = [
     # line too long (82 > 79 characters)
