From 1cc2945a3cbb35e5ece44334992873eb57bb052c Mon Sep 17 00:00:00 2001 From: TomLaclavere <129369785+TomLaclavere@users.noreply.github.com> Date: Wed, 11 Sep 2024 09:34:40 +0200 Subject: [PATCH] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 8c2b452..be1f9a3 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,9 @@ sphinx-build docs/ docs/html ``` The first line is used to build .rst files by reading the code in the package given by path_to_package (for example src/CMM). These files are stored in docs but not saved on Github for simplicity. + The second line reads the .rst files and converts them into .html files, which we use to generate the API documentation. + After a modification, if you want to visualize the documentation before committing it, you can use Firefox (or any other application) : ```