From 4b1371f760e2f8d4b6f1a16b9e2ae9d38228f592 Mon Sep 17 00:00:00 2001 From: Mauko Quiroga Date: Sat, 5 Oct 2024 18:26:38 +0200 Subject: [PATCH 1/4] docs: support raise lists --- source/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/conf.py b/source/conf.py index 1bcfd205..03e243ce 100644 --- a/source/conf.py +++ b/source/conf.py @@ -69,7 +69,10 @@ 'ignore-module-all': True } -napoleon_custom_sections = [('Returns', 'params_style')] +napoleon_custom_sections = [ + ('Raises', 'params_style'), + ('Returns', 'params_style'), +] def missing_reference(app, env, node, contnode): From aea1f7815e9a31152933da56978aec912063a1bd Mon Sep 17 00:00:00 2001 From: Mauko Quiroga Date: Sat, 5 Oct 2024 18:31:23 +0200 Subject: [PATCH 2/4] docs: update indexed enums --- source/openfisca-python-api/enum_array.rst | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/source/openfisca-python-api/enum_array.rst b/source/openfisca-python-api/enum_array.rst index 45b026cb..694caa48 100644 --- a/source/openfisca-python-api/enum_array.rst +++ b/source/openfisca-python-api/enum_array.rst @@ -2,13 +2,7 @@ Enum & EnumArray ================ -.. module:: openfisca_core.indexed_enums - -.. autoclass:: Enum - :members: - -.. autoclass:: EnumArray - :members: - -.. automodule:: openfisca_core.indexed_enums.config +.. automodule:: openfisca_core.indexed_enums :members: + :imported-members: + :special-members: __eq__, __ne__, __new__, __array_finalize__ From 633a29a501781343eb49823617a9c9cd85adc465 Mon Sep 17 00:00:00 2001 From: Mauko Quiroga Date: Sat, 5 Oct 2024 18:45:35 +0200 Subject: [PATCH 3/4] docs: add data storage --- source/openfisca-python-api/data_storage.rst | 8 ++++++++ source/openfisca-python-api/index.md | 1 + 2 files changed, 9 insertions(+) create mode 100644 source/openfisca-python-api/data_storage.rst diff --git a/source/openfisca-python-api/data_storage.rst b/source/openfisca-python-api/data_storage.rst new file mode 100644 index 00000000..48fdb369 --- /dev/null +++ b/source/openfisca-python-api/data_storage.rst @@ -0,0 +1,8 @@ +============ +Data Storage +============ + +.. automodule:: openfisca_core.data_storage + :members: + :imported-members: + :private-members: _decode_file diff --git a/source/openfisca-python-api/index.md b/source/openfisca-python-api/index.md index 7d81d8d7..25fe1f60 100644 --- a/source/openfisca-python-api/index.md +++ b/source/openfisca-python-api/index.md @@ -4,6 +4,7 @@ Modules: ```{toctree} commons +data_storage tax-benefit-system variables parameters From 56a918efd1d2c8909e3c00d2af4f398e3630924c Mon Sep 17 00:00:00 2001 From: Mauko Quiroga Date: Wed, 16 Oct 2024 15:32:35 +0200 Subject: [PATCH 4/4] build(make): fix test task --- Makefile | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 9e1e982a..a28637d6 100644 --- a/Makefile +++ b/Makefile @@ -14,7 +14,9 @@ install: @pip install --upgrade pip @pip install -r requirements.txt --use-deprecated=legacy-resolver -test: lint test-build +test: + @${MAKE} lint + @${MAKE} test-build test-build: @${MAKE} dummy SPHINXOPTS="--quiet --fail-on-warning"