Document functions which build the tax and transfer system.

[tobiasraabe]

What problem do you want to solve?

Display all internal functions in one document in the docs

Note that private functions are not displayed in the tables generated by autosummary, but are still documented below. We postpone making all functions public, to not break any functionality for the university course.

Resolves #194.

[codecov]

Codecov Report

Merging #197 into master will increase coverage by 0.11%.
The diff coverage is 98.80%.

@@            Coverage Diff             @@
##           master     #197      +/-   ##
==========================================
+ Coverage   94.54%   94.66%   +0.11%     
==========================================
  Files          54       56       +2     
  Lines        1613     1649      +36     
==========================================
+ Hits         1525     1561      +36     
  Misses         88       88              

Impacted Files	Coverage Δ
gettsim/benefits/arbeitsl_geld.py	95.65% <ø> (ø)
...ettsim/benefits/arbeitsl_geld_2/arbeitsl_geld_2.py	100.00% <ø> (ø)
gettsim/benefits/elterngeld.py	95.31% <ø> (ø)
gettsim/benefits/unterhalt.py	100.00% <ø> (ø)
gettsim/benefits/wohngeld.py	100.00% <ø> (ø)
gettsim/dag.py	88.13% <0.00%> (ø)
gettsim/demographic_vars.py	97.36% <ø> (ø)
gettsim/soz_vers/arbeitsl_v_rentenv.py	100.00% <ø> (ø)
gettsim/soz_vers/eink_grenzen.py	100.00% <ø> (ø)
gettsim/taxes/abgelt_st.py	100.00% <ø> (ø)
... and 11 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1c609fd...64fcc18. Read the comment docs.

[hmgaudecker]

Again, maybe it got lost somewhere: I'd love to have a full list of all functions as they appear in a graph, without the path prefix or grouping. Any chance to achieve that?

[tobiasraabe]

@hmgaudecker I think I have done what you wanted. I am not kidding this was one of the hardest issues with gettsim. You see that my solution combines two sphinx extensions and I reviewed even more. I really hope that's it :).

There are two functions which do not have a one-liner describing the functions, but a parameter entry. Thus they have this blue line in the table. Could you, @MaxBlesch, quickly add appropriate one-liners?

[hmgaudecker]

Very nice!

[hmgaudecker]

Last minute: We are missing things that are disambiguated because the functions change over time. E.g., "vorsorge" does not appear and I had a hard time finding it... Any ideas on how to include these? or should we just make the underlying functions public?

[hmgaudecker]

Alright, I hope this solves it. We should not rename all things to be public. But those that are disambiguated in policies_for_date.load_reforms_for_date().

It is fine :).

[tobiasraabe]

@hmgaudecker Merge?