From 176f2ecf6d8b2b3fa0e99a148aaa278887107e16 Mon Sep 17 00:00:00 2001 From: Nicolas Barthes <nicolas.barthes@cnrs.fr> Date: Thu, 18 Apr 2024 16:25:30 +0200 Subject: [PATCH] updated README.md with doc instructions --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index db30191..cc9c29f 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,10 @@ The app will open in your default browser. ## Usage The web app allows you to process sample selection, model creation and predictions. +## Documentation +The doc is generated with mkDoc and Python DocStrings. +From CLI, run +> mkdocs serve ## Authors and acknowledgment Contributors: - Nicolas Barthes (CNRS) -- GitLab