From 542f5ad8dfaf990d244fc66f7c2a81e3d876fc7f Mon Sep 17 00:00:00 2001 From: Paul Andrey <paul.andrey@inria.fr> Date: Mon, 19 Feb 2024 10:14:10 +0100 Subject: [PATCH] Fix docs' automated rendering. --- .gitignore | 3 ++- declearn/metrics/__init__.py | 2 +- scripts/gen_docs.py | 3 +++ 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 484ea2a8..b5ae727e 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 dd526969..445dbfe0 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 a2c68086..645ca0ff 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 -- GitLab