iza-institute-of-labor-economics · mj023 · Mar 24, 2023 · Mar 27, 2023 · Mar 29, 2023 · Mar 29, 2023
diff --git a/.gitignore b/.gitignore
@@ -69,5 +69,6 @@ ___*
 .env/installed_pip_pkgs
 .env/installed_spec.json
 docs/_build
+docs/gettsim_objects/apidocs
 docs/tutorials/sandbox_cz.ipynb
 _version.py
diff --git a/docs/conf.py b/docs/conf.py
@@ -36,6 +36,7 @@
     "sphinx.ext.viewcode",
     "sphinx_copybutton",
     "myst_parser",
+    "autodoc2",
 ]
 
 # The master toctree document.
@@ -59,8 +60,42 @@
 
 # -- Extensions configuration ------------------------------------------------
 
+myst_enable_extensions = ["fieldlist"]
+
 add_module_names = False
 
+autodoc2_packages = [
+    {
+        "path": "../src/_gettsim/social_insurance_contributions",
+    },
+    {
+        "path": "../src/_gettsim/taxes",
+    },
+    {
+        "path": "../src/_gettsim/transfers",
+    },
+]
+
+autodoc2_render_plugin = "myst"
+
+autodoc2_output_dir = "gettsim_objects/apidocs"
+
+autodoc2_index_template = """Policy functions in GETTSIM
+===============================
+
+This section documents the internal functions provided by GETTSIM to model the tax and
+transfer system [#f1]_.
+
+.. toctree::
+   :titlesonly:
+   :glob:
+{% for package in top_level %}
+   {{ package }}
+{%- endfor %}
+
+.. [#f1] Created with `sphinx-autodoc2
+    <https://github.com/chrisjsewell/sphinx-autodoc2>`_'"""
+
 autodoc_default_options = {
     "members": True,
     "private-members": True,

diff --git a/docs/gettsim_objects/index.md b/docs/gettsim_objects/index.md
@@ -7,7 +7,7 @@ This section documents the code inside GETTSIM.
 maxdepth: 1
 ---
 interface
-functions
+apidocs/index
 input_variables
 variables_out
 params

diff --git a/docs/gettsim_objects/interface.md b/docs/gettsim_objects/interface.md
@@ -4,12 +4,8 @@ This section provides the documentation of the two interface functions. If you w
 have more information on how they work and how you can use them please see
 {ref}`how_to_guides` and {ref}`tutorials`.
 
-```{eval-rst}
-.. currentmodule:: _gettsim.interface
-```
-
-```{eval-rst}
-.. autofunction:: compute_taxes_and_transfers
+```{autodoc2-object} _gettsim.interface.compute_taxes_and_transfers
+    render_plugin = "myst"
 ```
 
 ```{eval-rst}

diff --git a/environment.yml b/environment.yml
@@ -33,5 +33,6 @@ dependencies:
   - sphinx-copybutton
   - toml
   - pip:
+      - sphinx-autodoc2
       - kaleido
       - -e .
diff --git a/pyproject.toml b/pyproject.toml
@@ -65,7 +65,7 @@ write_to = "src/_gettsim/_version.py"
 
 
 [tool.ruff]
-target-version = "py311" # Replace by [project] requires-python = ">=3.11" above
+target-version = "py311"
 fix = true
 unsafe-fixes = false
-Original file line number
+Diff line change
@@ Expand Up / @@ -33,5 +33,6 @@ dependencies: @@
       - sphinx-copybutton
       - toml
       - pip:
+          - sphinx-autodoc2
           - kaleido
           - -e .