#984 reformat interface docs

pybamm-team · May 14, 2020 · daf49ed · daf49ed
1 parent 5a55dbd
commit daf49ed
Show file tree

Hide file tree

Showing 20 changed files with 46 additions and 107 deletions.
diff --git a/...t_order_kinetics/first_order_kinetics.rst → ...models/interface/first_order_kinetics.rst b/...t_order_kinetics/first_order_kinetics.rst → ...models/interface/first_order_kinetics.rst
diff --git a/docs/source/models/submodels/interface/first_order_kinetics/index.rst b/docs/source/models/submodels/interface/first_order_kinetics/index.rst
diff --git a/...odels/submodels/interface/first_order_kinetics/inverse_first_order_kinetics.rst b/...odels/submodels/interface/first_order_kinetics/inverse_first_order_kinetics.rst
diff --git a/docs/source/models/submodels/interface/index.rst b/docs/source/models/submodels/interface/index.rst
@@ -5,8 +5,8 @@ Interface
   :maxdepth: 1
 
   base_interface
-  kinetics/index
-  inverse_kinetics/index
-  first_order_kinetics/index
+  kinetics
+  inverse_kinetics
+  first_order_kinetics
   diffusion_limited
-  sei/index
+  sei
diff --git a/...nverse_kinetics/inverse_butler_volmer.rst → .../submodels/interface/inverse_kinetics.rst b/...nverse_kinetics/inverse_butler_volmer.rst → .../submodels/interface/inverse_kinetics.rst
@@ -1,5 +1,5 @@
-Inverse Butler-Volmer
-=====================
+Inverse Kinetics
+================
 
 .. autoclass:: pybamm.interface.inverse_kinetics.InverseButlerVolmer
     :members:
diff --git a/docs/source/models/submodels/interface/inverse_kinetics/index.rst b/docs/source/models/submodels/interface/inverse_kinetics/index.rst
diff --git a/docs/source/models/submodels/interface/kinetics.rst b/docs/source/models/submodels/interface/kinetics.rst
@@ -0,0 +1,17 @@
+Kinetics
+========
+
+.. autoclass:: pybamm.interface.BaseKinetics
+    :members:
+
+.. autoclass:: pybamm.interface.ButlerVolmer
+    :members:
+
+.. autoclass:: pybamm.interface.NoReaction
+    :members:
+
+.. autoclass:: pybamm.interface.ForwardTafel
+    :members:
+
+.. autoclass:: pybamm.interface.BackwardTafel
+    :members:
diff --git a/docs/source/models/submodels/interface/kinetics/base_kinetics.rst b/docs/source/models/submodels/interface/kinetics/base_kinetics.rst
diff --git a/docs/source/models/submodels/interface/kinetics/butler_volmer.rst b/docs/source/models/submodels/interface/kinetics/butler_volmer.rst
diff --git a/docs/source/models/submodels/interface/kinetics/index.rst b/docs/source/models/submodels/interface/kinetics/index.rst
diff --git a/docs/source/models/submodels/interface/kinetics/no_reaction.rst b/docs/source/models/submodels/interface/kinetics/no_reaction.rst
diff --git a/docs/source/models/submodels/interface/kinetics/tafel.rst b/docs/source/models/submodels/interface/kinetics/tafel.rst
diff --git a/docs/source/models/submodels/interface/sei.rst b/docs/source/models/submodels/interface/sei.rst
@@ -0,0 +1,23 @@
+SEI models
+==========
+
+.. autoclass:: pybamm.sei.BaseModel
+    :members:
+
+.. autoclass:: pybamm.sei.ConstantSEI
+    :members:
+
+.. autoclass:: pybamm.sei.ElectronMigrationLimited
+    :members:
+
+.. autoclass:: pybamm.sei.InterstitialDiffusionLimited
+    :members:
+
+.. autoclass:: pybamm.sei.NoSEI
+    :members:
+
+.. autoclass:: pybamm.sei.ReactionLimited
+    :members:
+
+.. autoclass:: pybamm.sei.SolventDiffusionLimited
+    :members:
diff --git a/docs/source/models/submodels/interface/sei/base_sei.rst b/docs/source/models/submodels/interface/sei/base_sei.rst
diff --git a/docs/source/models/submodels/interface/sei/electron_migration_limited.rst b/docs/source/models/submodels/interface/sei/electron_migration_limited.rst
diff --git a/docs/source/models/submodels/interface/sei/index.rst b/docs/source/models/submodels/interface/sei/index.rst
diff --git a/docs/source/models/submodels/interface/sei/interstitial_diffusion_limited.rst b/docs/source/models/submodels/interface/sei/interstitial_diffusion_limited.rst
diff --git a/docs/source/models/submodels/interface/sei/no_sei.rst b/docs/source/models/submodels/interface/sei/no_sei.rst
diff --git a/docs/source/models/submodels/interface/sei/reaction_limited.rst b/docs/source/models/submodels/interface/sei/reaction_limited.rst
diff --git a/docs/source/models/submodels/interface/sei/solvent_diffusion_limited.rst b/docs/source/models/submodels/interface/sei/solvent_diffusion_limited.rst