Skip to content

Commit

Permalink
add note about building documentation locally to STYLE.md
Browse files Browse the repository at this point in the history
Signed-off-by: Ali Caglayan <[email protected]>

<!-- ps-id: 4fac90bd-964d-475b-8abf-4091c2ae7f57 -->
  • Loading branch information
Alizter committed Oct 4, 2024
1 parent b68b52b commit e6aff7c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -1029,6 +1029,8 @@ The repository contains a file .dir-locals.el in the top-level directory
which turns on `visual-line-mode` when emacs visits any file in the
repository.

Documentation can be built locally using `make doc` or `dune build @theories/doc`. The HTML files generated by Dune are placed in `_build/default/HoTT.html/`.

Unfortunately, when viewing source code on Github, these long comment
lines are not wrapped, making them hard to read. If you use the
Stylish plugin, you can make them wrap by adding the following style:
Expand Down

0 comments on commit e6aff7c

Please sign in to comment.