add pension.rst file

jdebacker · Aug 8, 2024 · 2f66a35 · 2f66a35
1 parent 18661d1
commit 2f66a35
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/book/content/api/pensions.rst b/docs/book/content/api/pensions.rst
@@ -0,0 +1,16 @@
+.. _pensions:
+
+Pension Functions
+=================================================
+
+**pensions.py modules**
+
+ogcore.pensions
+------------------------------------------
+
+.. automodule:: ogcore.pensions
+  :members: replacement_rate_vals, pension_amount, SS_amount, DB_amount,
+    NDC_amount, PS_amount, deriv_theta, deriv_NDC, deriv_DB, deriv_PS,
+    delta_point, g_ndc, g_dir, delta_ret, deriv_DB_loop, deriv_PS_loop,
+    deriv_NDC_loop, delta_ret_loop, PS_1dim_loop, PS_2dim_loop, DB_1dim_loop,
+    DB_2dim_loop, NDC_1dim_loop, NDC_2dim_loop