Publish latest changes from openfisca/openfisca-doc@07639df

openfisca · May 21, 2024 · d07f0cc · d07f0cc
1 parent 379ccb7
commit d07f0cc
Show file tree

Hide file tree

Showing 143 changed files with 1,607 additions and 505 deletions.
diff --git a/doc/_modules/index.html b/doc/_modules/index.html
@@ -80,7 +80,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/entities/entity.html b/doc/_modules/openfisca_core/entities/entity.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/entities/group_entity.html b/doc/_modules/openfisca_core/entities/group_entity.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/entities/helpers.html b/doc/_modules/openfisca_core/entities/helpers.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/entities/role.html b/doc/_modules/openfisca_core/entities/role.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/errors/cycle_error.html b/doc/_modules/openfisca_core/errors/cycle_error.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/errors/empty_argument_error.html b/doc/_modules/openfisca_core/errors/empty_argument_error.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/errors/nan_creation_error.html b/doc/_modules/openfisca_core/errors/nan_creation_error.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/errors/parameter_not_found_error.html b/doc/_modules/openfisca_core/errors/parameter_not_found_error.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/errors/parameter_parsing_error.html b/doc/_modules/openfisca_core/errors/parameter_parsing_error.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/errors/period_mismatch_error.html b/doc/_modules/openfisca_core/errors/period_mismatch_error.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/errors/situation_parsing_error.html b/doc/_modules/openfisca_core/errors/situation_parsing_error.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/errors/spiral_error.html b/doc/_modules/openfisca_core/errors/spiral_error.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/errors/variable_name_config_error.html b/doc/_modules/openfisca_core/errors/variable_name_config_error.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/errors/variable_not_found_error.html b/doc/_modules/openfisca_core/errors/variable_not_found_error.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/holders/helpers.html b/doc/_modules/openfisca_core/holders/helpers.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/holders/holder.html b/doc/_modules/openfisca_core/holders/holder.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/indexed_enums/enum.html b/doc/_modules/openfisca_core/indexed_enums/enum.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>

diff --git a/doc/_modules/openfisca_core/indexed_enums/enum_array.html b/doc/_modules/openfisca_core/indexed_enums/enum_array.html
@@ -81,7 +81,7 @@ <h3>Navigation</h3>
     <ul>
 <li class="toctree-l1"><a class="reference internal" href="../../../index.html"><i icon-name="home"></i> Before you start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../architecture.html"><i icon-name="boxes"></i> Architecture of OpenFisca</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../installation/index.html"><i icon-name="download"></i> Getting started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../key-concepts/index.html"><i icon-name="lightbulb"></i> Key concepts</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../coding-the-legislation/index.html"><i icon-name="terminal"></i> From law to code</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../../simulate/index.html"><i icon-name="cog"></i> Running a simulation</a></li>