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" 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): 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/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__ 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