foucher/sphinx-tutorial
1
0
Fork 0
Code Pull requests Activity

correct readme

Browse source
This commit is contained in:
Alexandre Foucher 2024-01-24 12:58:03 +01:00
parent 149ab8e48a
commit 506be8be5c
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
cpp-example/readme.md
View file

@ -83,4 +83,7 @@ The best way is to go in `source/index.rst` and add `api/library_root` as an ent
**4. Now you can generate !**
Inside the `docs` directory you can now execute `make html` !
You can acces it through `docs/build/html/index.html`.
You can acces it through `docs/build/html/index.html`.
> :warning: **Warning**
> Do not store the `build` folder in your remote storage, if you use `git` simply copy the `.gitignore` inside `cpp-example/docs` and paste it to your `docs` folder.