diff --git a/docs/source/_templates/autosummary/module.rst b/docs/source/_templates/autosummary/module.rst new file mode 100644 index 0000000..fd632b4 --- /dev/null +++ b/docs/source/_templates/autosummary/module.rst @@ -0,0 +1,64 @@ +{{ fullname | escape | underline}} + +.. automodule:: {{ fullname }} + + {% block attributes %} + {% if attributes %} + .. rubric:: Module Attributes + + .. autosummary:: + :toctree: + {% for item in attributes %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block functions %} + {% if functions %} + .. rubric:: Functions + + {% for item in functions %} + .. autofunction:: {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block classes %} + {% if classes %} + .. rubric:: Classes + + {% for item in classes %} + .. autoclass:: {{ item }} + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + {%- endfor %} + {% endif %} + {% endblock %} + + {% block exceptions %} + {% if exceptions %} + .. rubric:: Exceptions + + {% for item in exceptions %} + .. autoexception:: {{ item }} + :members: + :show-inheritance: + {%- endfor %} + {% endif %} + {% endblock %} + +{% block modules %} +{% if modules %} +.. rubric:: Modules + +.. autosummary:: + :toctree: + :recursive: +{% for item in modules %} + {{ item }} +{%- endfor %} +{% endif %} +{% endblock %} diff --git a/docs/source/api/generated/ezmsg.learn.dim_reduce.adaptive_decomp.rst b/docs/source/api/generated/ezmsg.learn.dim_reduce.adaptive_decomp.rst index 47685c3..2c3ed95 100644 --- a/docs/source/api/generated/ezmsg.learn.dim_reduce.adaptive_decomp.rst +++ b/docs/source/api/generated/ezmsg.learn.dim_reduce.adaptive_decomp.rst @@ -4,18 +4,74 @@ .. automodule:: ezmsg.learn.dim_reduce.adaptive_decomp + + + + + + + + + .. rubric:: Classes - .. autosummary:: - - AdaptiveDecompSettings - AdaptiveDecompState - AdaptiveDecompTransformer - BaseAdaptiveDecompUnit - IncrementalPCASettings - IncrementalPCATransformer - IncrementalPCAUnit - MiniBatchNMFSettings - MiniBatchNMFTransformer - MiniBatchNMFUnit - \ No newline at end of file + + .. autoclass:: AdaptiveDecompSettings + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: AdaptiveDecompState + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: AdaptiveDecompTransformer + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: BaseAdaptiveDecompUnit + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: IncrementalPCASettings + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: IncrementalPCATransformer + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: IncrementalPCAUnit + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: MiniBatchNMFSettings + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: MiniBatchNMFTransformer + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: MiniBatchNMFUnit + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + + + + + + + + + diff --git a/docs/source/api/generated/ezmsg.learn.dim_reduce.incremental_decomp.rst b/docs/source/api/generated/ezmsg.learn.dim_reduce.incremental_decomp.rst index 2fe7c40..3ea10cc 100644 --- a/docs/source/api/generated/ezmsg.learn.dim_reduce.incremental_decomp.rst +++ b/docs/source/api/generated/ezmsg.learn.dim_reduce.incremental_decomp.rst @@ -4,11 +4,39 @@ .. automodule:: ezmsg.learn.dim_reduce.incremental_decomp + + + + + + + + + .. rubric:: Classes - .. autosummary:: - IncrementalDecompSettings - IncrementalDecompTransformer - IncrementalDecompUnit - \ No newline at end of file + .. autoclass:: IncrementalDecompSettings + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: IncrementalDecompTransformer + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: IncrementalDecompUnit + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + + + + + + + + + diff --git a/docs/source/api/generated/ezmsg.learn.linear_model.adaptive_linear_regressor.rst b/docs/source/api/generated/ezmsg.learn.linear_model.adaptive_linear_regressor.rst index 7311345..08a6672 100644 --- a/docs/source/api/generated/ezmsg.learn.linear_model.adaptive_linear_regressor.rst +++ b/docs/source/api/generated/ezmsg.learn.linear_model.adaptive_linear_regressor.rst @@ -3,4 +3,21 @@ .. automodule:: ezmsg.learn.linear_model.adaptive_linear_regressor - \ No newline at end of file + + + + + + + + + + + + + + + + + + diff --git a/docs/source/api/generated/ezmsg.learn.linear_model.cca.rst b/docs/source/api/generated/ezmsg.learn.linear_model.cca.rst index 825932e..1877aa3 100644 --- a/docs/source/api/generated/ezmsg.learn.linear_model.cca.rst +++ b/docs/source/api/generated/ezmsg.learn.linear_model.cca.rst @@ -3,4 +3,21 @@ .. automodule:: ezmsg.learn.linear_model.cca - \ No newline at end of file + + + + + + + + + + + + + + + + + + diff --git a/docs/source/api/generated/ezmsg.learn.linear_model.linear_regressor.rst b/docs/source/api/generated/ezmsg.learn.linear_model.linear_regressor.rst index f2addc4..3c0cb6f 100644 --- a/docs/source/api/generated/ezmsg.learn.linear_model.linear_regressor.rst +++ b/docs/source/api/generated/ezmsg.learn.linear_model.linear_regressor.rst @@ -3,4 +3,21 @@ .. automodule:: ezmsg.learn.linear_model.linear_regressor - \ No newline at end of file + + + + + + + + + + + + + + + + + + diff --git a/docs/source/api/generated/ezmsg.learn.linear_model.sgd.rst b/docs/source/api/generated/ezmsg.learn.linear_model.sgd.rst index 5708e5b..7907713 100644 --- a/docs/source/api/generated/ezmsg.learn.linear_model.sgd.rst +++ b/docs/source/api/generated/ezmsg.learn.linear_model.sgd.rst @@ -3,4 +3,21 @@ .. automodule:: ezmsg.learn.linear_model.sgd - \ No newline at end of file + + + + + + + + + + + + + + + + + + diff --git a/docs/source/api/generated/ezmsg.learn.linear_model.slda.rst b/docs/source/api/generated/ezmsg.learn.linear_model.slda.rst index c3961c0..d6b9198 100644 --- a/docs/source/api/generated/ezmsg.learn.linear_model.slda.rst +++ b/docs/source/api/generated/ezmsg.learn.linear_model.slda.rst @@ -3,4 +3,21 @@ .. automodule:: ezmsg.learn.linear_model.slda - \ No newline at end of file + + + + + + + + + + + + + + + + + + diff --git a/docs/source/api/generated/ezmsg.learn.model.cca.rst b/docs/source/api/generated/ezmsg.learn.model.cca.rst index 50a4555..65d0c32 100644 --- a/docs/source/api/generated/ezmsg.learn.model.cca.rst +++ b/docs/source/api/generated/ezmsg.learn.model.cca.rst @@ -4,9 +4,29 @@ .. automodule:: ezmsg.learn.model.cca + + + + + + + + + .. rubric:: Classes - .. autosummary:: - IncrementalCCA - \ No newline at end of file + .. autoclass:: IncrementalCCA + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + + + + + + + + + diff --git a/docs/source/api/generated/ezmsg.learn.model.mlp.rst b/docs/source/api/generated/ezmsg.learn.model.mlp.rst index 5319b40..8f4446d 100644 --- a/docs/source/api/generated/ezmsg.learn.model.mlp.rst +++ b/docs/source/api/generated/ezmsg.learn.model.mlp.rst @@ -4,9 +4,29 @@ .. automodule:: ezmsg.learn.model.mlp + + + + + + + + + .. rubric:: Classes - .. autosummary:: - MLP - \ No newline at end of file + .. autoclass:: MLP + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + + + + + + + + + diff --git a/docs/source/api/generated/ezmsg.learn.model.refit_kalman.rst b/docs/source/api/generated/ezmsg.learn.model.refit_kalman.rst index 27c1dff..90fbd2c 100644 --- a/docs/source/api/generated/ezmsg.learn.model.refit_kalman.rst +++ b/docs/source/api/generated/ezmsg.learn.model.refit_kalman.rst @@ -4,9 +4,29 @@ .. automodule:: ezmsg.learn.model.refit_kalman + + + + + + + + + .. rubric:: Classes - .. autosummary:: - RefitKalmanFilter - \ No newline at end of file + .. autoclass:: RefitKalmanFilter + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + + + + + + + + + diff --git a/docs/source/api/generated/ezmsg.learn.model.rnn.rst b/docs/source/api/generated/ezmsg.learn.model.rnn.rst index 3dd23b3..f5ee077 100644 --- a/docs/source/api/generated/ezmsg.learn.model.rnn.rst +++ b/docs/source/api/generated/ezmsg.learn.model.rnn.rst @@ -4,9 +4,29 @@ .. automodule:: ezmsg.learn.model.rnn + + + + + + + + + .. rubric:: Classes - .. autosummary:: - RNNModel - \ No newline at end of file + .. autoclass:: RNNModel + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + + + + + + + + + diff --git a/docs/source/api/generated/ezmsg.learn.model.transformer.rst b/docs/source/api/generated/ezmsg.learn.model.transformer.rst index afa95c6..bddb037 100644 --- a/docs/source/api/generated/ezmsg.learn.model.transformer.rst +++ b/docs/source/api/generated/ezmsg.learn.model.transformer.rst @@ -4,9 +4,29 @@ .. automodule:: ezmsg.learn.model.transformer + + + + + + + + + .. rubric:: Classes - .. autosummary:: - TransformerModel - \ No newline at end of file + .. autoclass:: TransformerModel + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + + + + + + + + + diff --git a/docs/source/api/generated/ezmsg.learn.util.rst b/docs/source/api/generated/ezmsg.learn.util.rst index 77a9717..2f2cd50 100644 --- a/docs/source/api/generated/ezmsg.learn.util.rst +++ b/docs/source/api/generated/ezmsg.learn.util.rst @@ -4,18 +4,49 @@ .. automodule:: ezmsg.learn.util + + + + + .. rubric:: Functions - .. autosummary:: - get_regressor + .. autofunction:: get_regressor + + + + .. rubric:: Classes - .. autosummary:: - AdaptiveLinearRegressor - ClassifierMessage - RegressorType - StaticLinearRegressor - \ No newline at end of file + .. autoclass:: AdaptiveLinearRegressor + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: ClassifierMessage + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: RegressorType + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + .. autoclass:: StaticLinearRegressor + :members: + :undoc-members: + :show-inheritance: + :special-members: __init__ + + + + + + + + + diff --git a/docs/source/conf.py b/docs/source/conf.py index 46814c9..ec899bd 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -44,10 +44,18 @@ # Auto-generate API docs autosummary_generate = True +autosummary_imported_members = False autodoc_typehints = "description" autodoc_member_order = "bysource" autodoc_typehints_format = "short" python_use_unqualified_type_names = True +autodoc_default_options = { + "members": True, + "member-order": "bysource", + "special-members": "__init__", + "undoc-members": True, + "show-inheritance": True, +} # Don't show the full module path in the docs add_module_names = False