diff --git a/.gitignore b/.gitignore index 484ea2a8a37b23757e427944b7d1107ee6bceb3a..b5ae727ef68f7d6e03447bf5e50f4c500927d045 100644 --- a/.gitignore +++ b/.gitignore @@ -17,9 +17,10 @@ coverage.xml examples/*/*.csv examples/*/*.pem examples/*/*/ -# Documentation online rendering files. +# Documentation rendered files. public/ site/ docs/api-reference/*/ docs/api-reference/SUMMARY.md docs/api-reference/typing.md +docs/api-reference/version.md diff --git a/declearn/metrics/__init__.py b/declearn/metrics/__init__.py index dd5269697017e16d8a262f79bd09980924cf496c..445dbfe0be659711708be35b67a6f2c4e7d5071a 100644 --- a/declearn/metrics/__init__.py +++ b/declearn/metrics/__init__.py @@ -25,7 +25,7 @@ Abstractions ------------ * [Metric][declearn.metrics.Metric]: Abstract base class defining an API for metrics' computation. -* [MetricState][declearn.metric.MetricState]: +* [MetricState][declearn.metrics.MetricState]: Abstract base class for Metrics intermediate aggregatable states. * [MeanMetric][declearn.metrics.MeanMetric]: Abstract class that defines a template for simple scores' averaging. diff --git a/scripts/gen_docs.py b/scripts/gen_docs.py index a2c6808659be8c78f77e22babcd007f9fb4a422a..645ca0ff357916c297c8304b2116f31ffedfeb07 100644 --- a/scripts/gen_docs.py +++ b/scripts/gen_docs.py @@ -151,6 +151,9 @@ def _generate_public_submodules_doc( pub_mod = {} for key, mod in module.modules.items(): if not key.startswith("_"): + if isinstance(mod, griffe.dataclasses.Alias): + key = f"{key} (alias re-export)" + mod = mod.target pub_mod[key] = generate_module_docs(mod, docdir) return pub_mod