From fa307c4ee75435e460e0ccb22941955feccac859 Mon Sep 17 00:00:00 2001 From: Fontrodona Nicolas <nicolas.fontrodona@ens-lyon.fr> Date: Wed, 28 Apr 2021 20:00:57 +0200 Subject: [PATCH] README.md: update --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 365d326..5d4bbf4 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,16 @@ This project requires `python>=3.8` to work correctly and the following modules * seaborn>=0.10.1 * matplotlib>=3.1.2 +## Build the Sphinx documentation + +The documentation was build using `Sphinx`. + +To build the documentation (which contains this document and the Api of the program), go in the doc folder and enter: + +```console +$ make html +``` + ## Usage ### `gc_content` module @@ -105,4 +115,4 @@ The figure to give to the `--norm` parameter must be defined like this: * The column condition must contain the same conditions defined in the `condition` column of the design file. * The column replicate must contain the same replicates names in the `replicate` column of the design file. -* The column coef contain a value used to normalise the coverage \ No newline at end of file +* The column coef contain a value used to normalise the coverage -- GitLab