Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TomLaclavere authored Sep 11, 2024
1 parent 43a9d23 commit 1cc2945
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) :

```
Expand Down

0 comments on commit 1cc2945

Please sign in to comment.