Mentions légales du service

Skip to content
Snippets Groups Projects
Verified Commit 542f5ad8 authored by ANDREY Paul's avatar ANDREY Paul
Browse files

Fix docs' automated rendering.

parent 6300a10e
No related branches found
No related tags found
1 merge request!63Finalize DecLearn v2.4.0.
...@@ -17,9 +17,10 @@ coverage.xml ...@@ -17,9 +17,10 @@ coverage.xml
examples/*/*.csv examples/*/*.csv
examples/*/*.pem examples/*/*.pem
examples/*/*/ examples/*/*/
# Documentation online rendering files. # Documentation rendered files.
public/ public/
site/ site/
docs/api-reference/*/ docs/api-reference/*/
docs/api-reference/SUMMARY.md docs/api-reference/SUMMARY.md
docs/api-reference/typing.md docs/api-reference/typing.md
docs/api-reference/version.md
...@@ -25,7 +25,7 @@ Abstractions ...@@ -25,7 +25,7 @@ Abstractions
------------ ------------
* [Metric][declearn.metrics.Metric]: * [Metric][declearn.metrics.Metric]:
Abstract base class defining an API for metrics' computation. 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. Abstract base class for Metrics intermediate aggregatable states.
* [MeanMetric][declearn.metrics.MeanMetric]: * [MeanMetric][declearn.metrics.MeanMetric]:
Abstract class that defines a template for simple scores' averaging. Abstract class that defines a template for simple scores' averaging.
......
...@@ -151,6 +151,9 @@ def _generate_public_submodules_doc( ...@@ -151,6 +151,9 @@ def _generate_public_submodules_doc(
pub_mod = {} pub_mod = {}
for key, mod in module.modules.items(): for key, mod in module.modules.items():
if not key.startswith("_"): 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) pub_mod[key] = generate_module_docs(mod, docdir)
return pub_mod return pub_mod
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment