diff --git a/README.md b/README.md index 365d32607f83e1cb47dd378f2cebf56a2d52e737..5d4bbf4abc52556ca9b14a19dbab359c54235527 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