Merge pull request PSLmodels#963 from jdebacker/param_doc

Merging

.github/workflows/deploy_docs.yml

@@ -35,7 +35,7 @@ jobs:
         run: |
           pip install -e .
           python -m ipykernel install --user --name=ogcore-dev
-          jb build ./docs/book
+          make build-docs
 
       - name: Deploy
         uses: JamesIves/github-pages-deploy-action@v4

.github/workflows/docs_check.yml

@@ -33,4 +33,4 @@ jobs:
         run: |
           pip install -e .
           python -m ipykernel install --user --name=ogcore-dev
-          jb build ./docs/book
+          make build-docs

Makefile

@@ -19,6 +19,7 @@ help:
 	@echo "coverage   : generate test coverage report"
 	@echo "git-sync   : synchronize local, origin, and upstream Git repos"
 	@echo "git-pr N=n : create local pr-n branch containing upstream PR"
+	@echo "make-docs  : build new Jupyter Book documentation files"
 
 .PHONY=clean
 clean:
@@ -65,6 +66,10 @@ git-sync:
 git-pr:
 	@./gitpr $(N)
 
+.PHONY=build-docs
+build-docs:
+	@cd ./docs ; python make_params.py; jb build ./book
+
 pip-package:
 	pip install wheel
 	python setup.py sdist bdist_wheel

docs/book/_toc.yml

@@ -23,6 +23,7 @@ parts:
 - caption: Appendix
   chapters:
   - file: content/theory/derivations
+  - file: content/intro/parameters
 - caption: References
   chapters:
   - file: content/OGCore_references

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