diff options
author | Antoine Musso <hashar@free.fr> | 2020-12-22 12:09:16 +0100 |
---|---|---|
committer | Antoine Musso <hashar@free.fr> | 2020-12-22 12:14:25 +0100 |
commit | 8e4ae547dc93fe3c158bf40bfef6b6a3bc43821d (patch) | |
tree | e8fb9613148e192165dbe92fe70ffff984a22b9b | |
parent | 4d1ddbc91bce04c382e9ca0bb9561b14600e9cee (diff) |
doc: document how to get flat html doc files
The documentation instructs to use:
bazel build Documentation:searchfree
Which results in a zip file one has to extract before browsing. I did it
with an inotify hook but that is cumbersome. Instead one can just call
the parent target `Documentation` which does not zip files:
bazel build Documentation
xdg-open bazel-out/Documentation/index.html
It is probably obvious to everyone, but might be a barrier of entry
toward adding more documentation.
Also specify the `withdocs` target is to build the Gerrit WAR.
Change-Id: If950229cb88b4b88f00a79ff1e5ae0885930c856
-rw-r--r-- | Documentation/dev-bazel.txt | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/Documentation/dev-bazel.txt b/Documentation/dev-bazel.txt index 96cc67ff61..188c38fe64 100644 --- a/Documentation/dev-bazel.txt +++ b/Documentation/dev-bazel.txt @@ -275,7 +275,15 @@ The html files will be bundled into `searchfree.zip` in this location: bazel-bin/Documentation/searchfree.zip ---- -To build the executable WAR with the documentation included: +To generate HTML files skipping the zip archiving: + +---- + bazel build Documentation +---- + +And open `bazel-bin/Documentation/index.html`. + +To build the Gerrit executable WAR with the documentation included: ---- bazel build withdocs |