Deploying to gh-pages from @ 9eb7169 🚀

_modules/index.html

@@ -169,7 +169,6 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../usage/starting.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../usage/overview.html">Structural overview</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../functions.html">Functions &amp; Methodology</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../usage/data.html">Data for Taxcalc-Payroll</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../guide/index.html">User guide</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../guide/python_interface.html">Python interface</a></li>
@@ -187,10 +186,14 @@
 </ul>
 </li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Functions</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../functions/model_interaction.html">Model Interaction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../functions/functions.html">Functions &amp; Methodology</a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../about/history.html">History</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../about/model_interaction.html">Model Interaction</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
 <ul class="nav bd-sidenav">

_modules/taxcalc/policy.html

@@ -169,7 +169,6 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../usage/starting.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage/overview.html">Structural overview</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../functions.html">Functions &amp; Methodology</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage/data.html">Data for Taxcalc-Payroll</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../guide/index.html">User guide</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../guide/python_interface.html">Python interface</a></li>
@@ -187,10 +186,14 @@
 </ul>
 </li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Functions</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../../functions/model_interaction.html">Model Interaction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../functions/functions.html">Functions &amp; Methodology</a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../about/history.html">History</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../about/model_interaction.html">Model Interaction</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
 <ul class="nav bd-sidenav">

_modules/taxcalc/records.html

@@ -169,7 +169,6 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../usage/starting.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage/overview.html">Structural overview</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../functions.html">Functions &amp; Methodology</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage/data.html">Data for Taxcalc-Payroll</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../guide/index.html">User guide</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../guide/python_interface.html">Python interface</a></li>
@@ -187,10 +186,14 @@
 </ul>
 </li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Functions</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../../functions/model_interaction.html">Model Interaction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../functions/functions.html">Functions &amp; Methodology</a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../about/history.html">History</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../about/model_interaction.html">Model Interaction</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
 <ul class="nav bd-sidenav">

_modules/taxcalc/taxcalcio.html

@@ -169,7 +169,6 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../usage/starting.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage/overview.html">Structural overview</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../functions.html">Functions &amp; Methodology</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage/data.html">Data for Taxcalc-Payroll</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../guide/index.html">User guide</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../guide/python_interface.html">Python interface</a></li>
@@ -187,10 +186,14 @@
 </ul>
 </li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Functions</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../../functions/model_interaction.html">Model Interaction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../functions/functions.html">Functions &amp; Methodology</a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../about/history.html">History</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../about/model_interaction.html">Model Interaction</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
 <ul class="nav bd-sidenav">

_modules/taxcalcpayroll/calculator.html

@@ -169,7 +169,6 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../usage/starting.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage/overview.html">Structural overview</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../functions.html">Functions &amp; Methodology</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage/data.html">Data for Taxcalc-Payroll</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../guide/index.html">User guide</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../guide/python_interface.html">Python interface</a></li>
@@ -187,10 +186,14 @@
 </ul>
 </li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Functions</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../../functions/model_interaction.html">Model Interaction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../functions/functions.html">Functions &amp; Methodology</a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../about/history.html">History</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../about/model_interaction.html">Model Interaction</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
 <ul class="nav bd-sidenav">

_modules/taxcalcpayroll/policy.html

@@ -169,7 +169,6 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../usage/starting.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage/overview.html">Structural overview</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../functions.html">Functions &amp; Methodology</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage/data.html">Data for Taxcalc-Payroll</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../guide/index.html">User guide</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../guide/python_interface.html">Python interface</a></li>
@@ -187,10 +186,14 @@
 </ul>
 </li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Functions</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../../functions/model_interaction.html">Model Interaction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../functions/functions.html">Functions &amp; Methodology</a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../about/history.html">History</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../about/model_interaction.html">Model Interaction</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
 <ul class="nav bd-sidenav">

_modules/taxcalcpayroll/records.html

@@ -169,7 +169,6 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../usage/starting.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage/overview.html">Structural overview</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../functions.html">Functions &amp; Methodology</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../usage/data.html">Data for Taxcalc-Payroll</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../../guide/index.html">User guide</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../../guide/python_interface.html">Python interface</a></li>
@@ -187,10 +186,14 @@
 </ul>
 </li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Functions</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../../functions/model_interaction.html">Model Interaction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../functions/functions.html">Functions &amp; Methodology</a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../../about/history.html">History</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../about/model_interaction.html">Model Interaction</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
 <ul class="nav bd-sidenav">

_sources/functions.md → _sources/functions/functions.md

@@ -5,18 +5,29 @@ Functions & Methodology
 
 Core functions of Taxcalc-Payroll are consisted of the payroll tax liability calculation functions and the employer side payroll offset function. The functions are are hosted in `calcfunctions.py` and `payrolloffset.py`. 
 
-Payroll tax liability functions can be used to calculate the FICA and SECA tax liability. These functions are inherited from Tax-Calculator and the usage remain the same. Please refer to this [recipe 1](https://bodiyang.github.io/Taxcalc-Payroll/recipes/recipe1.html), as the guide for tax revenue estimations and projections.
 
-Employer side payroll offset function can be used to measure the effect of employee side tax revenue offset, from a policy reform of the employer side payroll tax. Please refer to [recipe 2](https://bodiyang.github.io/Taxcalc-Payroll/recipes/recipe2.html).
+## Payroll Tax Calculation Functions
 
+### Brief
 
-## Employer Side Payroll Offset Function
+Payroll tax calculation functions are located in [`calcfunctions.py`](https://github.com/bodiyang/Taxcalc-Payroll/blob/master/taxcalcpayroll/calcfunctions.py). The functions are used to calculate FICA and SECA tax liability.
 
+`EI_PayrollTax`: Compute part of total OASDI+HI payroll taxes and earned income variables.
+`AdditionalMedicareTax`: Computes Additional Medicare Tax (Form 8959) included in payroll taxes.
+
+The payroll tax calculation functions are inherited from Tax-Calculator and the usage remain the same. 
+Please refer to this [recipe 1](https://bodiyang.github.io/Taxcalc-Payroll/recipes/recipe1.html), as the guide for tax revenue estimations and projections.
+
+## Employer Side Payroll Offset Function
 
 ### Brief
 
 Whenever government has a policy reform to raise the payroll tax rate from the employer, it is expected that more revenue would be collected from the employer side. However, another effect would happen at the same time, that there would be a decrease of the tax revenue from the employee side. This is known to be the employer side payroll offset effect.
 
+Core function `employer_payroll_offset` is located in [payrolloffset.py](https://github.com/bodiyang/Taxcalc-Payroll/blob/master/taxcalcpayroll/payrolloffset.py). Employer side payroll offset function can be used to measure the effect of employee side tax revenue offset, from a policy reform of the employer side payroll tax. 
+
+Please refer to [recipe 2](https://bodiyang.github.io/Taxcalc-Payroll/recipes/recipe2.html) for the usage.
+
 
 ### Methodology
 

about/history.html

@@ -65,8 +65,8 @@
     <script>DOCUMENTATION_OPTIONS.pagename = 'about/history';</script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Model Interaction" href="model_interaction.html" />
-    <link rel="prev" title="Recipe3: Comparison of Different Payroll Tax Reforms" href="../recipes/recipe3.html" />
+    <link rel="next" title="Contributor guide" href="../contributing/contributor_guide.html" />
+    <link rel="prev" title="Functions &amp; Methodology" href="../functions/functions.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -172,7 +172,6 @@
 <ul class="nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="../usage/starting.html">Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../usage/overview.html">Structural overview</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../functions.html">Functions &amp; Methodology</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../usage/data.html">Data for Taxcalc-Payroll</a></li>
 <li class="toctree-l1 has-children"><a class="reference internal" href="../guide/index.html">User guide</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
 <li class="toctree-l2"><a class="reference internal" href="../guide/python_interface.html">Python interface</a></li>
@@ -190,10 +189,14 @@
 </ul>
 </li>
 </ul>
+<p aria-level="2" class="caption" role="heading"><span class="caption-text">Functions</span></p>
+<ul class="nav bd-sidenav">
+<li class="toctree-l1"><a class="reference internal" href="../functions/model_interaction.html">Model Interaction</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../functions/functions.html">Functions &amp; Methodology</a></li>
+</ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">About</span></p>
 <ul class="current nav bd-sidenav">
 <li class="toctree-l1 current active"><a class="current reference internal" href="#">History</a></li>
-<li class="toctree-l1"><a class="reference internal" href="model_interaction.html">Model Interaction</a></li>
 </ul>
 <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contributing</span></p>
 <ul class="nav bd-sidenav">
@@ -493,20 +496,20 @@ <h2>Origins of Taxcalc-Payroll<a class="headerlink" href="#origins-of-taxcalc-pa
 
 <div class="prev-next-area">
     <a class="left-prev"
-       href="../recipes/recipe3.html"
+       href="../functions/functions.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
-        <p class="prev-next-title">Recipe3: Comparison of Different Payroll Tax Reforms</p>
+        <p class="prev-next-title">Functions &amp; Methodology</p>
       </div>
     </a>
     <a class="right-next"
-       href="model_interaction.html"
+       href="../contributing/contributor_guide.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
-        <p class="prev-next-title">Model Interaction</p>
+        <p class="prev-next-title">Contributor guide</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>